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 git repositories.
  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 publicly 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   Is there anything left for read-only support?
  46
  47 * Combined "super server" for NNTP/HTTP/POP3 to reduce memory overhead
  48
  49 * Configurable linkification for per-inbox shorthands:
  50   "$gmane/123456" could be configured to expand to the
  51   appropriate link pointing to the gmane.io list archives,
  52   likewise "[Bug #123456]" could be configured to expand to
  53   point to some project's bug tracker at http://example.com/bug/123456
  54
  55 * configurable synonym and spelling support in Xapian
  56
  57 * Support optional "HTTPS Everywhere" for mapping old HTTP to HTTPS
  58   links if (and only if) the user wants to use HTTPS.  We may also
  59   be able to configure redirects for expired URLs.
  60
  61   Note: message bodies rendered as HTML themselves must NOT change,
  62   the links should point to an anchor tag within the same page,
  63   instead; giving the user options.
  64
  65 * configurable constants (index limits, search results)
  66
  67 * handle messages with multiple Message-IDs (done for v2, doable for v1)
  68
  69 * handle broken double-bracketed References properly (maybe)
  70   and totally broken Message-IDs
  71
  72   cf.  https://public-inbox.org/git/20160814012706.GA18784@starla/
  73
  74 * improve documentation
  75
  76 * linkify thread skeletons better
  77   https://public-inbox.org/git/6E3699DEA672430CAEA6DEFEDE6918F4@PhilipOakley/
  78
  79 * Further lower mail parser memory usage.  We still slurp entire
  80   message bodies into memory and incur 2-3x overhead on
  81   multipart messages.  Inline::C (and maybe gmime) could work.
  82
  83 * use REQUEST_URI properly for CGI / mod_perl2 compatibility
  84   with Message-IDs which include '%' (done?)
  85
  86 * more and better test cases (use git fast-import to speed up creation)
  87
  88 * large mbox/Maildir/MH/NNTP spool import (see PublicInbox::Import)
  89
  90 * Read-only WebDAV interface to the git repo so it can be mounted
  91   via davfs2 or fusedav to avoid full clones.
  92   davfs2 needs Range: request support for this to be feasible:
  93     https://savannah.nongnu.org/bugs/?33259
  94     https://savannah.nongnu.org/support/?107649
  95
  96 * Contribute something like IMAP IDLE for "git fetch".
  97   Inboxes (and any git repos) can be kept up-to-date without
  98   relying on polling.
  99
 100 * Improve bundle support in git to make it cheaper to host/clone
 101   with dumb HTTP(S) servers.
 102
 103 * Expose targeted reindexing of individual messages.
 104   Sometimes an indexing bug only affects a handful of messages,
 105   so it's not worth the trouble of doing a full reindex.
 106
 107 * code repository integration (cgit: done, TODO: gitweb, etc...)
 108
 109 * migration path to v2 without breaking v1 "git fetch" cronjobs
 110
 111 * imperfect scraper importers for obfuscated list archives
 112   (e.g. obfuscated Mailman stuff, Google Groups, etc...)
 113
 114 * improve performance and avoid head-of-line blocking on slow storage
 115
 116 * share "git cat-file --batch" processes across inboxes to avoid
 117   bumping into /proc/sys/fs/pipe-user-pages-* limits
 118
 119 * make "git cat-file --batch" detect unlinked packfiles so we don't
 120   have to restart processes (very long-term)
 121
 122 * support searching based on `git-patch-id --stable` to improve
 123   bidirectional mapping of commits <=> emails
 124
 125 * linter to check validity of config file
 126
 127 * linter option and WWW endpoint to graph relationships and flows
 128   between inboxes, addresses maildirs, coderepos, etc...
 129
 130 * pygments support - via Python script similar to `git cat-file --batch'
 131   to avoid startup penalty.  pygments.rb (Ruby) can be inspiration, too.
 132
 133 * highlighting + linkification for "git format-patch --interdiff" output
 134
 135 * highlighting + linkification for "git format-patch --range-diff" output
 136   (requires mirroring of git repos)
 137
 138 * parse and allow (semi)automatic-mirroring of "git request-pull" output
 139   for coderepos
 140
 141 * configurable diff output for solver-generated blobs
 142
 143 * figure out how search for messages with multiple Date: headers
 144   should work (some wacky examples out there...)
 145
 146 * support UUCP addresses for legacy archives