TODO

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