TODO

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