TODO

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