1 Some Privoxy-related tasks, sorted by the time they
2 have been added, not by priority.
4 The latest version should be available at:
5 https://www.privoxy.org/gitweb/?p=privoxy.git;a=blob_plain;f=TODO;hb=HEAD
7 There's work in progress to fund development on these items using
8 donations. If you want to donate, please have a look at:
9 https://www.privoxy.org/faq/general.html#DONATE
11 1) Add more regression tests. Filters should be tested automatically
12 (variables too). Could probably reuse large parts of Privoxy-Filter-Test.
13 Note that there is currently work in progress to leverage curl's
14 test suite, patches have been submitted upstream:
15 http://curl.haxx.se/mail/lib-2014-06/0070.html
17 3) Fix some more XXX: comments.
19 6) Remove actions that aren't needed anymore:
21 content-type-overwrite should probably stay as it's also
22 used by some of the CGI pages (XXX: name them).
24 crunch-client-header and crunch-server-header should probably
25 go, their only advantage is that their search strings can be
26 controlled through the CGI pages, other than that they only
29 crunch-if-none-match can be replaced with a header filter.
31 prevent-compression has a misleading name and could
32 be replaced with a header filter.
34 7) force-text-mode has a stupid name and should probably
35 be renamed to force-filter-mode.
37 8) handle-as-empty-document and handle-as-image should
38 be merged to something like handle-as{something} to
39 prevent them from being activated at the same time.
41 10) There's a bug in the CGI editor that turns the
42 first section's "Insert new section below" into
43 a "Insert new section above" button.
45 11) CGI templates should use semantically-correct HTML
50 12) Support pipelining for outgoing connections.
52 14) Allow to filter POST parameters.
54 16) Filter SSL encrypted content as well.
56 At the beginning we could use a unencrypted connection between
57 client and Privoxy, and use an encrypted connection between
58 Privoxy and the server.
60 This should be good enough for most of the content the
61 user would want to filter.
65 19) enable-forward-fallback. Syntax? Suggested by K.R.
67 21) User Manual delivery doesn't accept multiple slashes. Should it?
69 22) Verify action files properly (Including arguments) and
70 act accordingly (should probably intercept all requests
71 with a "Invalid option foo detected" CGI page).
73 23) Do the same in case of syntax errors in the configuration file,
74 instead of just exiting or ignoring the problem.
76 25) Handle multiple filters with the same name better. Reject them?
78 26) Let show-url-info detect clearly invalid URLs.
80 27) Make errno logging less thread-unsafe.
81 Verify that it's really an improvement.
83 28) Don't take default ports in case of invalid forwarding ports.
85 31) If a string action foo is disabled csp->action->string[ACTION_STRING_FOO]
86 doesn't necessarily contain NULL, but may contain the string of an
87 enabled foo action in an overruled section. Is it a bug? Does it matter?
89 32) In case of forwarding failures with socks port == 9050,
90 show extra info about Tor (the whole FAQ entry?).
92 36) Unload unused action files directly, even if they are
93 disabled without replacement.
95 38) In the final results, explicitly list disabled multi actions
96 with their parameters. Not as trivial as it sounds.
98 40) When running in daemon mode, Privoxy's working directory is '/'
99 which means it may not have permissions to dump core when necessary.
100 Figure out a way to solve this. Introduce a cwd config option?
102 41) Change documentation framework to one that works cross-platform.
103 Evaluate WML and txt2tags.
105 42) Add a DTrace USDT provider. Now that FreeBSD has userland DTrace
106 support there's no longer any reason not to.
108 43) Write a tool to check URL patterns against URLs in the log file.
109 This could be included in Privoxy-Regression-Test.
111 44) Privoxy-Log-Parser: Consider highlighting "Connection" in:
112 23:13:03.506 283b6100 Header: Replaced: 'Connection: Keep-Alive' with 'Connection: close'
114 50) Investigate possible PCRS template speedup when searching
115 macros with strstr() before compiling pcrs commands.
116 Investigated, needs some restructuring but is probably worth it.
118 51) Make user-manual directive more generic to allow serving the FAQ
119 and files from user-specified directories. Consider changing the
120 port for "same origin policy" issues.
122 53) Find a more reliable hoster. Involves finding out what our
123 requirements are and which SF alternatives fulfil them.
124 It would probably also make sense to look into what other
125 projects did when migrating away from SF.
127 2014-05: Work in progress. Hosting wish list at the end
128 of this file. Looks like most of the other projects
129 that left SF had lower standards and moved to hosters
130 that don't come close to sattisfying the requirements.
131 2016-03: The website has been moved away from SF infrastructure
132 and is also available through https:// now.
133 2016-04: Server rent for a year has been sponsored by ChameleonJohn.
134 2016-04: The SF mailing lists have been deprecated, the new ones
135 are available at: https://lists.privoxy.org/
137 Interested donors: 1.
139 54) Move away from CVS to a more modern revision control system.
140 The move to git is work in progress:
141 https://sourceforge.net/p/ijbswa/mailman/message/34994343/
143 58) Move more template strings from the code into the actual templates.
145 59) Import the German template translation.
147 60) Ask the Russian translators for input on how to make their
150 61) Consider (optionally?) skipping the hostname comparison when
151 checking if a connections that goes to a HTTP proxy can be reused.
152 Do all HTTP proxy support that? Is it worth it?
154 63) Reject clearly too large requests earlier?
156 64) Use proper copyright attribution. "Privoxy Developers"
159 65) Polish Website. Probably involves ditching the Docbook
160 mess. There are already several threads in the mailinglist
161 archives about this. See also #41.
163 66) Stop hard-coding the number of action and filter files.
165 67) Clean up source code directory layout. Depends on 54 so
166 we don't lose the revision history.
168 68) Use standard make syntax so we don't depend on GNU make.
170 69) Update autoconf setup (or move away from it).
171 Unfortunately the autoconf files can't be simply updated
172 due to license issues:
173 https://lists.privoxy.org/pipermail/privoxy-devel/2016-April/000008.html
175 70) If the server connection is reset but the headers are
176 received, consider passing the mess to the client instead
177 of showing the connect-failed template. Relates to #2698674.
179 74) Let Privoxy-Regression-Test optionally check that action
180 sections which disable actions actually are preceded by
181 sections that enable said actions.
183 75) Create a tool that creates Privoxy action (and filter?) files
184 out of adblock files. Could be implemented as option for
185 url-pattern-translator.pl.
187 76) Cache DNS responses. Note that this has been requested
188 several times by users, but is not a developer priority.
189 If you care about this, feel free to submit patches.
191 77) Allow to configure the IP address used in outgoing connections.
193 78) Allow to optionally use pcre's DFA algorithm.
195 79) Evaluate pcre alternatives.
197 80) Change FEATURE_EXTENDED_HOST_PATTERNS to support both
198 extended and vanilla host patterns at the same time.
200 Note that the requirement is to allow the user to decide
201 if the domain pattern should be interpreted as regex or
202 traditional host pattern and if it's not obvious that the
203 user made any decision, default to the latter.
205 Possible solutions would be:
207 1. An always-use-regex-domain-patterns config option
208 2. An enable-regex-domain-patterns-for-this-action-file option
209 3. An enable-regex-domain-patterns-for-this-action-file-until-the-user-says-otherwise option
210 4. A treat-the-domain-pattern-in-this-line-as-regex(-or-not) option
211 5. Combinations of the options above
213 With 2+4, 3+4 or 2+3+4 being the preferences until
216 82) Detect if the system time goes back in time let the user
217 know if it caused any connections to get closed.
219 85) Once #51 is done, write a script that populates a directory with
220 various common third-party icons (stumbleupon.png, facebook.png ...)
221 and redirect requests for them to Privoxy.
223 86) Add a server-body-tagger action. This is trivial as as all the
224 functionality required to do it already exists.
226 87) Add a client-body-tagger action. This is less trivial as we currently
227 don't buffer client bodies. After 14) is implemented it would be
230 88) Investigate if there's a Perl module that Privoxy-Regression-Test
231 could optionally use to keep connections alive, preferably while
232 requiring less forks at the same time.
234 89) When multiple block actions apply, consider showing all the block
235 reasons on the blocked page that haven't been overruled, not just
238 91) Add an optional limit for internal redirects. It would probably
239 be reasonable to default to a limit of one and showing an error
240 message if the request for the redirect URL would be redirected
243 92) The statistics currently aren't calculated correctly by Privoxy
244 as each thread is only counted as one request which is no longer
245 correct. This should be fixed, or the statistic code removed.
246 Privoxy-Log-Parser's provides more detailed statistics, anyway.
248 93) Add a config directive to let Privoxy explicitly request either
249 IPv4 (or IPv6) addresses, even if the system supports both.
250 Could be useful as a workaround for misconfigured setups where the
251 libc returns IPv6 addresses even if there's no IPv6 connectivity.
253 94) Add a config directive to let Privoxy prefer either IPv4 (or IPv6)
254 addresses, instead of trusting the libc to return them in an order
255 that makes sense. Like #93, this could be useful as a workaround
256 for misconfigured setups.
258 96) Filters should be easier to look up. Currently get_filter() has to
259 go through all filters and skip the filter types the caller isn't
262 98) When showing action section on the CGI pages, properly escape
263 line breaks so they can be copy&pasted into action files without
266 99) Figure out a mechanism through which a user can easily enable
267 site-specific action sections that are too aggressive to be
268 enabled by default. This could be similar to the presettings
269 in default.action, but could also be just another action file
270 that isn't used by default.
272 100) Create a cross-platform Privoxy control program and retire
273 the win32 GUI. Integrate support for Privoxy-Regression-Test,
274 Privoxy-Log-Parser, Privoxy-Filter-Test, uagen and similar tools.
275 Interested donors: 1.
277 102) Add an include directive to split the config file into several parts.
279 103) Potential performance improvement for large action files:
280 when figuring out which actions apply, check the action bit mask
281 before pattern matching and skip section that wouldn't modify the
282 actions already set. To increase the impact the sections would have
283 to be applied in reverse.
285 104) The code to modify global_toggle_state should be factored out into
286 a separate function. Currently we mess with it in three different
287 files, but only in w32log.c the tray icon is explicitly set.
288 The logging is inconsistent as well. For details see #3525694.
290 106) actionlist.h should be embedded in a way that causes less text
293 107) Support more pcrs variables, for example $destination-ip-address
294 and $source-ip-address.
296 108) Allow to use a somewhat random string instead of PRIVOXY-FORCE.
298 109) Let log_error() support the format specifier %S which should
299 work like %s but escape new lines like %N. This would be useful
300 to log the result of header filters which may inject new lines.
302 110) Add a global-buffer-limit directive that roughly limits how
303 much malloc'ed memory Privoxy will use and can potentially
304 be smaller than (buffer-limit * max-client-connections).
306 111) Reject requests if hosts and ports in request line and Host
307 header don't match (before filters have been applied).
309 112) If a header filter is used to inject another header by inserting
310 a \r\n (undocumented feature), detect it and split the headers so
311 following header actions do not treat them as a single string.
312 Alternatively add another header injection mechanism.
314 113) Log statistics upon receiving a certain signal (SIGINFO or SIGUSR1).
316 114) Properly deal with status code 100. The current "Continue hack"
317 can cause problems for gpg when uploading keys through Privoxy.
319 115) Add ICAP (RFC 3507) support. FR #3615158.
321 116) Due to the use of sscanf(), Privoxy currently will fail to properly
322 parse chunks whose size can't be represented with 32 bit. This is
323 unlikely to cause problems in the real world, but should eventually
324 be fixed anyway. See also:
325 https://bugzilla.mozilla.org/show_bug.cgi?id=959100
327 118) There should be "escaped" dynamic variables that are guaranteed
328 not to break filters.
330 119) Evaluate using pcre's jit mode.
332 120) Add an option to limit pcre's recursion limit below the default.
333 On some platforms the recursion limit doesn't prevent pcre from
334 running out of stack space, causing the kernel to kill Privoxy
337 121) Add HTTP/2 support. As a first step, incoming HTTP/1.x requests
338 should be translated to outgoing HTTP/2 requests where possible
339 (and if desired by the user).
340 Interested donors: 1.
342 122) Allow customized log messages.
344 123) Evaluate if the voluntarily-disclose-session-keys option in Firefox
345 (and other browsers) can be leveraged. Probably depends on #16.
347 124) Add support for the "lightweight OS capability and sandbox framework"
348 Capsicum. http://www.cl.cam.ac.uk/research/security/capsicum/
349 Interested donors: 1.
351 125) Allow clients to HTTPS-encrypt the proxy connection.
352 Interested donors: 1.
354 126) Run the Co-Advisor HTTP compliance tests, evaluate the results,
355 fix the compliance issues that aren't by design and document
357 Note that Privoxy developers qualify for free account upgrades:
358 http://coad.measurement-factory.com/details.html#pricing
360 127) Add "real" CGI support (serve program output instead of forwarding
361 the request). The work is mostly done due to +external-filter{}.
363 128) Add a config directive to control the stack limit.
365 129) Completely implement RFC 7230 4.1 (Chunked Transfer Coding).
366 Currently Privoxy doesn't properly deal with trailers which
367 are rarely used in the real world but should be supported anyway.
369 130) Move header_tagger() out of the parser structs and let it execute
370 taggers one-by-one against all headers so the header order has less
371 influence on the tagging result. As a bonus, dynamic taggers would
372 have to be compiled less often.
374 131) The handle-as-empty-doc-returns-ok directive should be replaced with
375 an action so the behaviour can be enabled on a per-request basis.
376 Interested donors: 1.
378 133) Consider allowing bitcoin donations.
379 Interested donors: 2.
381 134) Track the total number of bytes written to and received from a socket.
383 135) Add OpenBSM audit support.
385 136) Make builds reproducible.
387 137) Add a (preferably vector-based) logo.
389 138) Bring back the scripts to provide actions file feedback.
391 Once upon a time (~2003) there were scripts on the webserver
392 to make reporting action file feedback more convenient for the
393 user and the actual reports more useful for the developers.
394 They have been unusable for years and have thus been disabled,
395 but making the reporting mechanism available again would be a
398 140) Toggling Privoxy off currently also disables stuff that
399 probably shouldn't be affected (such as actions like
400 forward-override). Investigate and fix or document.
402 141) Port Privoxy to CloudABI, which, despite the name, is actually
403 rather neat. https://github.com/NuxiNL/cloudlibc
405 142) Remove or update the "internal" pcre version.
407 143) Add support for OpenBSD's pledge feature once it's stablelized.
408 This should be a lot less work then #124.
410 146) Allow to save the internal client tag state to disk and
411 load it after restarts.
413 147) Improve "Building from Source" section in the user manual.
414 A common problem seems to be that it's not obvious to non-technical
415 users how the listed dependencies can be installed on the commonly
416 used platforms. Adding a couple of examples should also be useful for
417 technical users (like Privoxy developers) who want to install or test
418 Privoxy on platforms they are not familiar with.
420 148) Add a config directive to change the CGI_SITE_2_HOST
421 (default: config.privoxy.org).
423 If Privoxy is used as reverse proxy or intercepting proxy without
424 getting intercepted requests, error pages created from default templates
425 currently can result in client requests to config.privoxy.org on the
426 Internet which may not be desirable.
428 150) Add blacklistd support.
430 151) Let the dok-tidy target work cross-platform without introducing
431 a ton of white-space changes that hide the content changes.
433 152) Fix CSS references in the website documentation.
434 For many pages p_doc.css is specified twice using different paths.
435 Usually at least one works, but not all of them do and the
436 duplicated requests are pointless even if they don't end up with
439 153) Catch SIGINT and use it to close the listen socket, serve
440 remaining connections and shut down. This would allow higher
441 uptime and make testing more convenient.
443 154) Underline links in docs and cgi pages. More precisely,
444 don't mess with the browser defaults for link underlining.
446 155) The sig_handler() shouldn't call log_error().
447 While it isn't known to cause actual problems in normal operation,
448 it's technically incorrect and causes crashes when running in
451 156) Reject socks requests with an explicit error message similar
452 to the one used for ftp. Motivation:
453 https://lists.privoxy.org/pipermail/privoxy-users/2017-March/000195.html
455 158) Use a single thread to wait for new requests on reused client connections.
456 Currently the thread that handles the first request on a connection
457 stays responsible for the client connect until it gets closed.
458 In case of lots of idle connections lots of waiting threads are used.
459 While it's conceivable that this ineffiency is irrelevant from a
460 performance point of view, using a single thread should reduce Privoxy's
461 memory footprint a bit which may be noticeable in case of multi-user setups
462 with hundreds of idle connections.
463 ##########################################################################
465 Hosting wish list (relevant for #53)
470 - Mailinglists (Mailman with public archives preferred)
471 - Webspace (on a Unix-like OS that works with the webserver targets
473 - Source code repositories (currently CVS, but migrating away
474 from it is TODO #54 anyway and shouldn't be too much trouble)
475 - Commit mails (preferably with unified diffs)
477 (Unsorted) details to look at when evaluating hosters:
479 1. Preferably no third-party ads and trackers.
480 External images, CSS and JavaScript may count as trackers
481 but texts like "supported by company XYZ" may be acceptable.
483 2. JavaScript should be optional or not used at all.
485 3. Services we don't need shouldn't be enabled anyway.
486 (We currently don't use Web forums, wikis, surveys etc.)
488 4. It would be preferable if the hoster didn't have a bad track
489 record as far as user experience, security and privacy are
490 concerned and if the terms of service are "reasonable" and
491 haven't changed too often in the past. Updates in the past
492 should have been improvements and not regressions.
494 5. It would be preferable if most of the server administration
495 is done by a trusted third-party (or at least not a lot of work
498 6. The server(s) should be located in a country with laws we can
499 understand and follow (or at least not unintentionally violate).
501 7. A server location in a country with some kind of due process
502 and strong data protection laws (at least on paper) would be
505 8. Given that Privoxy is a free software project it would be
506 preferable if the hoster would use free software where possible.
508 9. Migrating away from the hoster in the future without losing
509 any important data should be possible without writing web