TODO

   1 $Id: TODO,v 1.47 2011/07/04 17:48:11 fabiankeil Exp $
   2
   3 Some Privoxy related tasks, sorted by the time they
   4 have been added, not by priority.
   5
   6 1)  Add some regression tests. Filters should be tested automatically
   7     (variables too). Could probably reuse large parts of Privoxy-Filter-Test.
   8
   9 3)  Fix some more XXX: comments.
  10
  11 4)  Fix some more compiler warnings. (Especially on amd64)
  12     Partly done.
  13
  14 6)  Remove actions that aren't needed anymore:
  15
  16     content-type-overwrite should probably stay as it's also
  17     used by some of the CGI pages (XXX: name them).
  18
  19     crunch-client-header and crunch-server-header should probably
  20     go, their only advantage is that their search strings can be
  21     controlled through the CGI pages, other than that they only
  22     have disadvantages.
  23
  24     crunch-if-none-match can be replaced with a header filter.
  25
  26     prevent-compression has a misleading name and could
  27     be replaced with a header filter.
  28
  29 7)  force-text-mode has a stupid name and should probably
  30     be renamed to force-filter-mode.
  31
  32 8)  handle-as-empty-document and handle-as-image should
  33     be merged to something like handle-as{something} to
  34     prevent them from being activated at the same time.
  35
  36 10) There's a bug in the CGI editor that turns the
  37     first section's "Insert new section below" into
  38     a "Insert new section above" button.
  39
  40 11) CGI templates should use semantically-correct HTML
  41     and scale properly.
  42
  43 12) Add pipelining support.
  44
  45 14) Allow to filter POST parameters.
  46
  47 15) If trusted CGI pages are requested without trusted referrer,
  48     set the status code to 403 instead of 200.
  49
  50 16) Filter SSL encrypted content as well.
  51
  52     At the beginning we could use a unencrypted connection between
  53     client and Privoxy, and use an encrypted connection between
  54     Privoxy and the server.
  55
  56     This should be good enough for most of the content the
  57     user would want to filter.
  58
  59 19) enable-forward-fallback. Syntax? Suggested by K.R.
  60
  61 21) User Manual delivery doesn't accept multiple slashes. Should it?
  62
  63 22) Verify action files properly (Including arguments) and
  64     act accordingly (should probably intercept all requests
  65     with a "Invalid option foo detected" CGI page).
  66
  67 23) Do the same in case of syntax errors in the configuration file,
  68     instead of just exiting or ignoring the problem.
  69
  70 25) Handle multiple filters with the same name better. Reject them?
  71
  72 26) Let show-url-info detect clearly invalid URLs.
  73
  74 27) Make errno logging less thread-unsafe.
  75     Verify that it's really an improvement.
  76
  77 28) Don't take default ports in case of invalid forwarding ports.
  78
  79 31) If a string action foo is disabled csp->action->string[ACTION_STRING_FOO]
  80     doesn't necessarily contain NULL, but may contain the string of an
  81     enabled foo action in an overruled section. Is it a bug? Does it matter?
  82
  83 32) In case of forwarding failures with socks port == 9050,
  84     show extra info about Tor (the whole FAQ entry?).
  85
  86 36) Unload unused action files directly, even if they are
  87     disabled without replacement.
  88
  89 38) In the final results, explicitly list disabled multi actions
  90     with their parameters. Not as trivial as it sounds.
  91
  92 40) When running in daemon mode, Privoxy's working directory is '/'
  93     which means it may not have permissions to dump core when necessary.
  94     Figure out a way to solve this. Introduce a cwd config option?
  95
  96 41) Change documentation framework to one that works cross-platform.
  97     Evaluate WML.
  98
  99 42) Add DTrace hooks. Now that FreeBSD has userland DTrace
 100     support there's no longer any reason not to.
 101     DTrace bible preorderd.
 102
 103 43) Write a tool to check URL patterns against URLs in the log file.
 104     This could be included in Privoxy-Regression-Test.
 105
 106 44) Privoxy-Log-Parser: Consider highlighting "Connection" in:
 107     23:13:03.506 283b6100 Header: Replaced: 'Connection: Keep-Alive' with 'Connection: close'
 108
 109 49) Add FAQ for NTLM proxies. Still necessary?
 110
 111 50) Investigate possible PCRS template speedup when searching
 112     macros with strstr() before compiling pcrs commands.
 113     Investigated, needs some restructuring but is probably worth it.
 114
 115 51) Make user-manual directive more generic to allow serving
 116     the FAQ and other stuff, too. Consider changing the port
 117     for "same origin policy" issues.
 118
 119 53) Find a more reliable hoster. Involves finding out what our
 120     requirements are and which SF alternatives fulfil them.
 121     It would probably also make sense to look into what other
 122     projects did when migrating away from SF.
 123
 124 54) Move away from CVS to a more modern revision control system.
 125     Find out if there are any objection against going with Git.
 126     Using Git would also have the advantage that SF now pretents
 127     to support it, so we could do it independently from 53).
 128
 129 55) Apply for Coverity scans: http://scan.coverity.com/
 130
 131 56) Apply for the "free online access for qualified open-source
 132     software projects" for the Co-Advisor HTTP compliance tests:
 133     http://coad.measurement-factory.com/details.html#pricing
 134
 135 57) Allow piping into external programs to allow more powerful
 136     filters and policy decisions. Incomplete support available
 137     in Fabian's popen branch.
 138
 139 58) Move more template strings from the code into the actual templates.
 140
 141 59) Import the German template translation.
 142
 143 60) Ask the Russian translators for input on how to make their
 144     life easier.
 145
 146 61) Consider (optionally?) skipping the hostname comparison when
 147     checking if a connections that goes to a HTTP proxy can be reused.
 148     Do all HTTP proxy support that? Is it worth it?
 149
 150 63) Reject clearly too large requests earlier?
 151
 152 64) Use proper copyright attribution. "Privoxy Developers"
 153     is no legal entity.
 154
 155 65) Polish Website. Probably involves ditching the Docbook
 156     mess in favour of wml. There should be already some threads
 157     in the mailinglists archives about this. See also #41.
 158
 159 66) Increase maximum number of action and filter files.
 160
 161 67) Clean up source code directory layout. Depends on 54 so
 162     we don't lose the revision history.
 163
 164 68) Use standard make syntax so we don't depend on GNU make.
 165
 166 69) Update autoconf setup (or move away from it).
 167
 168 70) If the server connection is reset but the headers are
 169     received, consider passing the mess to the client instead
 170     of showing the connect-failed template. Relates to #2698674.
 171
 172 71) Allow to listen on multiple addresses without having to
 173     bind to all.
 174
 175 74) Let Privoxy-Regression-Test optionally check that action
 176     sections which disable actions actually are preceded by
 177     sections that enable said actions.
 178
 179 75) Create a tool that creates Privoxy action (and filter?) files
 180     out of adblock files. Could be implemented as option for
 181     url-pattern-translator.pl.
 182
 183 76) Cache DNS responses. Note that this has been requested
 184     several times by users, but is not a developer priority.
 185     If you care about this, feel free to submit patches.
 186
 187 77) Allow to configure the IP address used in outgoing connections.
 188
 189 78) Allow to optionally use pcre's DFA algorithm.
 190
 191 79) Evaluate pcre alternatives.
 192
 193 80) Change FEATURE_EXTENDED_HOST_PATTERNS to support both
 194     extended and vanilla host patterns at the same time.
 195
 196     Note that the requirement is to allow the user to decide
 197     if the domain pattern should be interpreted as regex or
 198     traditional host pattern and if it's not obvious that the
 199     user made any decision, default to the latter.
 200
 201     Possible solutions would be:
 202
 203     1. An always-use-regex-domain-patterns config option
 204     2. An enable-regex-domain-patterns-for-this-action-file option
 205     3. An enable-regex-domain-patterns-for-this-action-file-until-the-user-says-otherwise option
 206     4. A treat-the-domain-pattern-in-this-line-as-regex(-or-not) option
 207     5. Combinations of the options above
 208
 209     With 2+4, 3+4 or 2+3+4 being the preferences until
 210     further discussion.
 211
 212 82) Detect if the system time goes back in time let the user
 213     know if it caused any connections to get closed.
 214
 215 83) Make the FAQ available through the CGI interface like the
 216     user manual is.
 217
 218 84) Flesh out the user-manual delivery to serve pages from
 219     other directories, too.
 220
 221 85) Once #84 is done, write a script that populates a directory with
 222     various common third-party icons (stumbleupon.png, facebook.png ...)
 223     and redirect requests for them to Privoxy.
 224
 225 86) Add a server-body-tagger action. This is trivial as as all the
 226     functionallity required to do it already exists.
 227
 228 87) Add a client-body-tagger action. This is less trivial as we currently
 229     don't buffer client bodies. After 14) is implemented it would be
 230     trivial, though.
 231
 232 88) Investigate if there's a Perl module that Privoxy-Regression-Test
 233     could optionally use to keep connections alive.
 234
 235 89) When multiple block actions apply, consider showing all the block
 236     reasons on the blocked page that haven't been overruled, not just
 237     the last one.
 238
 239 90) Implement NO-TAG: patterns that enable a section if the
 240     provided pattern doesn't match any TAG. This would make
 241     some things cleaner.
 242
 243 91) Add an optional limit for internal redirects. It would probably
 244     be reasonable to default to a limit of one and showing an error
 245     message if the request for the redirect URL would be redirected
 246     again.
 247
 248 92) The statistics currently aren't calculated correctly by Privoxy
 249     as each thread is only counted as one request which is no longer
 250     correct. This should be fixed, or the statistic code removed.
 251     Privoxy-Log-Parser's provides more detailed statistics, anyway.
 252
 253 93) Add a config directive to let Privoxy explicitly request either
 254     IPv4 (or IPv6) addresses, even if the system supports both.
 255     Could be useful as a workaround for misconfigured setups where the
 256     libc returns IPv6 addresses even if there's no IPv6 connectivity.
 257
 258 94) Add a config directive to let Privoxy prefer either IPv4 (or IPv6)
 259     addresses, instead of trusting the libc to return them in an order
 260     that makes sense. Like #93, this could be useful as a workaround
 261     for misconfigured setups.