TODO

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