]> Sergey Matveev's repositories - public-inbox.git/blob - TODO
doc: technical/ds.txt: describe PublicInbox::DS divergences
[public-inbox.git] / TODO
1 TODO items for public-inbox
2
3 (Not in any particular order, and
4 performance, ease-of-setup, installation, maintainability, etc
5 all need to be considered for everything we introduce)
6
7 * general performance improvements, but without relying on
8   XS or pre-built modules any more than we currently do.
9   (Optional Inline::C and user-compiled re2c acceptable)
10
11 * mailmap support (same as git) for remapping expired email addresses
12
13 * support remapping of expired URLs similar to mailmap
14   (coordinate with git.git with this?)
15
16 * POP3 server, since some webmail providers support external POP3:
17   https://public-inbox.org/meta/20160411034104.GA7817@dcvr.yhbt.net/
18   Perhaps make this depend solely the NNTP server and work as a proxy.
19   Meaning users can run this without needing a full copy of the
20   archives in a git repository.
21
22 * HTTP and NNTP proxy support.  Allow us to be a frontend for
23   firewalled off (or Tor-exclusive) instances.  The use case is
24   for offering a publically accessible IP with a cheap VPS,
25   yet storing large amounts of data on computers without a
26   public IP behind a home Internet connection.
27
28 * support HTTP(S) CONNECT proxying to NNTP for users with
29   firewall problems
30
31 * DHT (distributed hash table) for mapping Message-IDs to various
32   archive locations to avoid SPOF.
33
34 * optional Cache::FastMmap support so production deployments won't
35   need Varnish (Varnish doesn't protect NNTP, either)
36
37 * dogfood and take advantage of new kernel APIs (while maintaining
38   portability to older Linux, free BSDs and maybe Hurd).
39
40 * dogfood latest Xapian, Perl5, SQLite, git and various modules to
41   ensure things continue working as they should (or more better)
42   while retaining compatibility with old versions.
43
44 * Support more of RFC 3977 (NNTP)
45
46 * Combined "super server" for NNTP/HTTP/POP3 to reduce memory overhead
47
48 * Configurable linkification for per-inbox shorthands:
49   "$gmane/123456" could be configured to expand to the
50   appropriate link pointing to the gmane.org list archives,
51   likewise "[Bug #123456]" could be configured to expand to
52   point to some project's bug tracker at http://example.com/bug/123456
53
54 * configurable synonym and spelling support in Xapian
55
56 * Support optional "HTTPS Everywhere" for mapping old HTTP to HTTPS
57   links if (and only if) the user wants to use HTTPS.  We may also
58   be able to configure redirects for expired URLs.
59
60   Note: message bodies rendered as HTML themselves must NOT change,
61   the links should point to an anchor tag within the same page,
62   instead; giving the user options.
63
64 * configurable constants (index limits, search results)
65
66 * handle messages with multiple Message-IDs (done for v2, doable for v1)
67
68 * handle broken double-bracketed References properly (maybe)
69   and totally broken Message-IDs
70
71   cf.  https://public-inbox.org/git/20160814012706.GA18784@starla/
72
73 * improve documentation
74
75 * linkify thread skeletons better
76   https://public-inbox.org/git/6E3699DEA672430CAEA6DEFEDE6918F4@PhilipOakley/
77
78 * low-memory Email::MIME replacement: currently we generate many
79   allocations/strings for headers we never look at and slurp
80   entire message bodies into memory.  GMime+Inline::C could work.
81
82 * use REQUEST_URI properly for CGI / mod_perl2 compatibility
83   with Message-IDs which include '%' (done?)
84
85 * more and better test cases (use git fast-import to speed up creation)
86
87 * large mbox/Maildir/MH/NNTP spool import (see PublicInbox::Import)
88
89 * Read-only WebDAV interface to the git repo so it can be mounted
90   via davfs2 or fusedav to avoid full clones.
91   davfs2 needs Range: request support for this to be feasible:
92     https://savannah.nongnu.org/bugs/?33259
93     https://savannah.nongnu.org/support/?107649
94
95 * Contribute something like IMAP IDLE for "git fetch".
96   Inboxes (and any git repos) can be kept up-to-date without
97   relying on polling.
98
99 * Improve bundle support in git to make it cheaper to host/clone
100   with dumb HTTP(S) servers.
101
102 * Expose targeted reindexing of individual messages.
103   Sometimes an indexing bug only affects a handful of messages,
104   so it's not worth the trouble of doing a full reindex.
105
106 * code repository integration (with cgit, gitweb, etc...)
107
108 * migration path to v2 without breaking v1 "git fetch" cronjobs
109
110 * imperfect scraper importers for obfuscated list archives
111   (e.g. obfuscated Mailman stuff, Google Groups, etc...)
112
113 * improve performance and avoid head-of-line blocking on slow storage
114
115 * share "git cat-file --batch" processes across inboxes to avoid
116   bumping into /proc/sys/fs/pipe-user-pages-* limits
117
118 * make "git cat-file --batch" detect unlinked packfiles so we don't
119   have to restart processes (very long-term)
120
121 * support searching based on `git-patch-id --stable` to improve
122   bidirectional mapping of commits <=> emails
123
124 * linter to check validity of config file
125
126 * linter option and WWW endpoint to graph relationships and flows
127   between inboxes, addresses maildirs, coderepos, etc...
128
129 * pygments support - via Python script similar to `git cat-file --batch'
130   to avoid startup penalty.  pygments.rb (Ruby) can be inspiration, too.
131
132 * highlighting + linkification for "git format-patch --interdiff" output
133
134 * highlighting + linkification for "git format-patch --range-diff" output
135   (requires mirroring of git repos)
136
137 * parse and allow (semi)automatic-mirroring of "git request-pull" output
138   for coderepos
139
140 * configurable diff output for solver-generated blobs
141
142 * figure out how search for messages with multiple Date: headers
143   should work (some wacky examples out there...)
144
145 * support UUCP addresses for legacy archives