add faq for what to do if editing the config file is access denied
[privoxy.git] / TODO
diff --git a/TODO b/TODO
index eac1ba3..fbc5dc0 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,4 +1,4 @@
-$Id: TODO,v 1.111 2014/06/02 07:23:14 fabiankeil Exp $
+$Id: TODO,v 1.165 2017/05/29 10:40:28 fabiankeil Exp $
 
 Some Privoxy-related tasks, sorted by the time they
 have been added, not by priority.
@@ -6,10 +6,15 @@ have been added, not by priority.
 The latest version should be available at:
 http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 
-1)  Add some regression tests. Filters should be tested automatically
+There's work in progress to fund development on these items using
+donations. If you want to donate, please have a look at:
+http://www.privoxy.org/faq/general.html#DONATE
+
+1)  Add more regression tests. Filters should be tested automatically
     (variables too). Could probably reuse large parts of Privoxy-Filter-Test.
     Note that there is currently work in progress to leverage curl's
-    test suite which could be used for this as well.
+    test suite, patches have been submitted upstream:
+    http://curl.haxx.se/mail/lib-2014-06/0070.html
 
 3)  Fix some more XXX: comments.
 
@@ -42,13 +47,12 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 11) CGI templates should use semantically-correct HTML
     and scale properly.
 
+    Work in progress.
+
 12) Support pipelining for outgoing connections.
 
 14) Allow to filter POST parameters.
 
-15) If trusted CGI pages are requested without trusted referrer,
-    set the status code to 403 instead of 200.
-
 16) Filter SSL encrypted content as well.
 
     At the beginning we could use a unencrypted connection between
@@ -58,6 +62,8 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
     This should be good enough for most of the content the
     user would want to filter.
 
+    Interested donors: 2.
+
 19) enable-forward-fallback. Syntax? Suggested by K.R.
 
 21) User Manual delivery doesn't accept multiple slashes. Should it?
@@ -96,7 +102,7 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
     Figure out a way to solve this. Introduce a cwd config option?
 
 41) Change documentation framework to one that works cross-platform.
-    Evaluate WML.
+    Evaluate WML and txt2tags.
 
 42) Add a DTrace USDT provider. Now that FreeBSD has userland DTrace
     support there's no longer any reason not to.
@@ -111,24 +117,30 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
     macros with strstr() before compiling pcrs commands.
     Investigated, needs some restructuring but is probably worth it.
 
-51) Make user-manual directive more generic to allow serving
-    the FAQ and other stuff, too. Consider changing the port
-    for "same origin policy" issues.
+51) Make user-manual directive more generic to allow serving the FAQ
+    and files from user-specified directories. Consider changing the
+    port for "same origin policy" issues.
 
 53) Find a more reliable hoster. Involves finding out what our
     requirements are and which SF alternatives fulfil them.
     It would probably also make sense to look into what other
     projects did when migrating away from SF.
 
-    2014-05-13: Work in progress. Hosting wish list at the end
-    of this file.
+    2014-05: Work in progress. Hosting wish list at the end
+             of this file. Looks like most of the other projects
+             that left SF had lower standards and moved to hosters
+             that don't come close to sattisfying the requirements.
+    2016-03: The website has been moved away from SF infrastructure
+             and is also available through https:// now.
+    2016-04: Server rent for a year has been sponsored by ChameleonJohn.
+    2016-04: The SF mailing lists have been deprecated, the new ones
+             are available at: https://lists.privoxy.org/
 
-54) Move away from CVS to a more modern revision control system.
-    Find out if there are any objection against going with Git.
-    Using Git would also have the advantage that SF now pretends
-    to support it, so we could do it independently from 53).
+    Interested donors: 1.
 
-55) Apply for Coverity scans: http://scan.coverity.com/
+54) Move away from CVS to a more modern revision control system.
+    The move to git is work in progress:
+    https://sourceforge.net/p/ijbswa/mailman/message/34994343/
 
 58) Move more template strings from the code into the actual templates.
 
@@ -147,8 +159,8 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
     is no legal entity.
 
 65) Polish Website. Probably involves ditching the Docbook
-    mess in favour of wml. There are already several threads
-    in the mailinglist archives about this. See also #41.
+    mess. There are already several threads in the mailinglist
+    archives about this. See also #41.
 
 66) Stop hard-coding the number of action and filter files.
 
@@ -158,6 +170,9 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 68) Use standard make syntax so we don't depend on GNU make.
 
 69) Update autoconf setup (or move away from it).
+    Unfortunately the autoconf files can't be simply updated
+    due to license issues:
+    https://lists.privoxy.org/pipermail/privoxy-devel/2016-April/000008.html
 
 70) If the server connection is reset but the headers are
     received, consider passing the mess to the client instead
@@ -203,10 +218,7 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 82) Detect if the system time goes back in time let the user
     know if it caused any connections to get closed.
 
-84) Flesh out the user-manual delivery to serve pages from
-    other directories, too.
-
-85) Once #84 is done, write a script that populates a directory with
+85) Once #51 is done, write a script that populates a directory with
     various common third-party icons (stumbleupon.png, facebook.png ...)
     and redirect requests for them to Privoxy.
 
@@ -272,6 +284,7 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 100) Create a cross-platform Privoxy control program and retire
      the win32 GUI. Integrate support for Privoxy-Regression-Test,
      Privoxy-Log-Parser, Privoxy-Filter-Test, uagen and similar tools.
+     Interested donors: 1.
 
 102) Add an include directive to split the config file into several parts.
 
@@ -335,9 +348,10 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
      running out of stack space, causing the kernel to kill Privoxy
      ungracefully.
 
-121) Add HTTP/2 support. As a first step, incomming HTTP/1.x requests
+121) Add HTTP/2 support. As a first step, incoming HTTP/1.x requests
      should be translated to outgoing HTTP/2 requests where possible
      (and if desired by the user).
+     Interested donors: 1.
 
 122) Allow customized log messages.
 
@@ -346,13 +360,15 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 
 124) Add support for the "lightweight OS capability and sandbox framework"
      Capsicum. http://www.cl.cam.ac.uk/research/security/capsicum/
+     Interested donors: 1.
 
 125) Allow clients to HTTPS-encrypt the proxy connection.
+     Interested donors: 1.
 
 126) Run the Co-Advisor HTTP compliance tests, evaluate the results,
      fix the compliance issues that aren't by design and document
      the rest.
-     Note that Privoxy developers qualified for free account upgrades:
+     Note that Privoxy developers qualify for free account upgrades:
      http://coad.measurement-factory.com/details.html#pricing
 
 127) Add "real" CGI support (serve program output instead of forwarding
@@ -360,6 +376,104 @@ http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
 
 128) Add a config directive to control the stack limit.
 
+129) Completely implement RFC 7230 4.1 (Chunked Transfer Coding).
+     Currently Privoxy doesn't properly deal with trailers which
+     are rarely used in the real world but should be supported anyway.
+
+130) Move header_tagger() out of the parser structs and let it execute
+     taggers one-by-one against all headers so the header order has less
+     influence on the tagging result. As a bonus, dynamic taggers would
+     have to be compiled less often.
+
+131) The handle-as-empty-doc-returns-ok directive should be replaced with
+     an action so the behaviour can be enabled on a per-request basis.
+     Interested donors: 1.
+
+133) Consider allowing bitcoin donations.
+     Interested donors: 2.
+
+134) Track the total number of bytes written to and received from a socket.
+
+135) Add OpenBSM audit support.
+
+136) Make builds reproducible.
+
+137) Add a (preferably vector-based) logo.
+
+138) Bring back the scripts to provide actions file feedback.
+
+     Once upon a time (~2003) there were scripts on the webserver
+     to make reporting action file feedback more convenient for the
+     user and the actual reports more useful for the developers.
+     They have been unusable for years and have thus been disabled,
+     but making the reporting mechanism available again would be a
+     good idea.
+
+140) Toggling Privoxy off currently also disables stuff that
+     probably shouldn't be affected (such as actions like
+     forward-override). Investigate and fix or document.
+
+141) Port Privoxy to CloudABI, which, despite the name, is actually
+     rather neat. https://github.com/NuxiNL/cloudlibc
+
+142) Remove or update the "internal" pcre version.
+
+143) Add support for OpenBSD's pledge feature once it's stablelized.
+     This should be a lot less work then #124.
+
+146) Allow to save the internal client tag state to disk and
+     load it after restarts.
+
+147) Improve "Building from Source" section in the user manual.
+     A common problem seems to be that it's not obvious to non-technical
+     users how the listed dependencies can be installed on the commonly
+     used platforms. Adding a couple of examples should also be useful for
+     technical users (like Privoxy developers) who want to install or test
+     Privoxy on platforms they are not familiar with.
+
+148) Add a config directive to change the CGI_SITE_2_HOST
+     (default: config.privoxy.org).
+
+     If Privoxy is used as reverse proxy or intercepting proxy without
+     getting intercepted requests, error pages created from default templates
+     currently can result in client requests to config.privoxy.org on the
+     Internet which may not be desirable.
+
+150) Add blacklistd support.
+
+151) Let the dok-tidy target work cross-platform without introducing
+     a ton of white-space changes that hide the content changes.
+
+152) Fix CSS references in the website documentation.
+     For many pages p_doc.css is specified twice using different paths.
+     Usually at least one works, but not all of them do and the
+     duplicated requests are pointless even if they don't end up with
+     a 404.
+
+153) Catch SIGINT and use it to close the listen socket, serve
+     remaining connections and shut down. This would allow higher
+     uptime and make testing more convenient.
+
+154) Underline links in docs and cgi pages. More precisely,
+     don't mess with the browser defaults for link underlining.
+
+155) The sig_handler() shouldn't call log_error().
+     While it isn't known to cause actual problems in normal operation,
+     it's technically incorrect and causes crashes when running in
+     valgrind.
+
+156) Reject socks requests with an explicit error message similar
+     to the one used for ftp. Motivation:
+     https://lists.privoxy.org/pipermail/privoxy-users/2017-March/000195.html
+
+158) Use a single thread to wait for new requests on reused client connections.
+     Currently the thread that handles the first request on a connection
+     stays responsible for the client connect until it gets closed.
+     In case of lots of idle connections lots of waiting threads are used.
+     While it's conceivable that this ineffiency is irrelevant from a
+     performance point of view, using a single thread should reduce Privoxy's
+     memory footprint a bit which may be noticeable in case of multi-user setups
+     with hundreds of idle connections.
 ##########################################################################
 
 Hosting wish list (relevant for #53)