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 * HTTP, IMAP, NNTP, POP3 proxy support.  Allow us to be a frontend for
  17   firewalled off (or Tor-exclusive) instances.  The use case is
  18   for offering a publicly accessible IP with a cheap VPS,
  19   yet storing large amounts of data on computers without a
  20   public IP behind a home Internet connection.
  21
  22 * support HTTP(S) CONNECT proxying to IMAP/NNTP/POP3 for users with
  23   firewall problems
  24
  25 * DHT (distributed hash table) for mapping Message-IDs to various
  26   archive locations to avoid SPOF.
  27
  28 * optional Cache::FastMmap support so production deployments won't
  29   need Varnish (Varnish doesn't protect NNTP nor IMAP, either)
  30
  31 * dogfood and take advantage of new kernel APIs (while maintaining
  32   portability to older Linux, free BSDs and maybe Hurd).
  33
  34 * dogfood latest Xapian, Perl5, SQLite, git and various modules to
  35   ensure things continue working as they should (or more better)
  36   while retaining compatibility with old versions.
  37
  38 * Support more of RFC 3977 (NNTP)
  39   Is there anything left for read-only support?
  40
  41 * Configurable linkification for per-inbox shorthands:
  42   "$gmane/123456" could be configured to expand to the
  43   appropriate link pointing to the gmane.io list archives,
  44   likewise "[Bug #123456]" could be configured to expand to
  45   point to some project's bug tracker at http://example.com/bug/123456
  46
  47 * configurable synonym and spelling support in Xapian
  48
  49 * Support optional "HTTPS Everywhere" for mapping old HTTP to HTTPS
  50   links if (and only if) the user wants to use HTTPS.  We may also
  51   be able to configure redirects for expired URLs.
  52
  53   Note: message bodies rendered as HTML themselves must NOT change,
  54   the links should point to an anchor tag within the same page,
  55   instead; giving the user options.
  56
  57 * configurable constants (index limits, search results)
  58
  59 * handle messages with multiple Message-IDs (done for v2, doable for v1)
  60
  61 * handle broken double-bracketed References properly (maybe)
  62   and totally broken Message-IDs
  63
  64   cf.  https://public-inbox.org/git/20160814012706.GA18784@starla/
  65
  66 * improve documentation
  67
  68 * linkify thread skeletons better
  69   https://public-inbox.org/git/6E3699DEA672430CAEA6DEFEDE6918F4@PhilipOakley/
  70
  71 * Further lower mail parser memory usage.  We still slurp entire
  72   message bodies into memory and incur 2-3x overhead on
  73   multipart messages.  Inline::C (and maybe gmime) could work.
  74
  75 * use REQUEST_URI properly for CGI / mod_perl2 compatibility
  76   with Message-IDs which include '%' (done?)
  77
  78 * better test cases, make faster by reusing more setup
  79   code across tests
  80
  81 * large mbox/Maildir/MH/NNTP spool import (in lei, but not
  82   for public-facing inboxes)
  83
  84 * MH import support (read-only, at least)
  85
  86 * Read-only WebDAV interface to the git repo so it can be mounted
  87   via davfs2 or fusedav to avoid full clones.
  88   davfs2 needs Range: request support for this to be feasible:
  89     https://savannah.nongnu.org/bugs/?33259
  90     https://savannah.nongnu.org/support/?107649
  91
  92 * Contribute something like IMAP IDLE for "git fetch".
  93   Inboxes (and any git repos) can be kept up-to-date without
  94   relying on polling.
  95
  96 * Improve bundle support in git to make it cheaper to host/clone
  97   with dumb HTTP(S) servers.
  98
  99 * Expose targeted reindexing of individual messages.
 100   Sometimes an indexing bug only affects a handful of messages,
 101   so it's not worth the trouble of doing a full reindex.
 102
 103 * code repository integration (cgit: done, TODO: gitweb, etc...)
 104
 105 * migration path to v2 (making it transparent for "git fetch"
 106   may not be possible, but "public-inbox-fetch" will handle it)
 107
 108 * imperfect scraper importers for obfuscated list archives
 109   (e.g. obfuscated Mailman stuff, Google Groups, etc...)
 110
 111 * improve performance and avoid head-of-line blocking on slow storage
 112   (done for most git blob retrievals, Xapian needs work)
 113
 114 * HTTP(S) search API (likely JMAP, but GraphQL could be an option)
 115   It should support git-specific prefixes (dfpre:, dfpost:, dfn:, etc)
 116   as extensions.  If JMAP, it should have HTTP(S) analogues to
 117   various IMAP extensions.
 118
 119 * scalability to tens/hundreds of thousands of inboxes
 120
 121   - inotify-based manifest.js.gz updates
 122
 123   ...
 124
 125 * lei - see %CMD in lib/PublicInbox/LEI.pm
 126   (there's a truckload here..)
 127
 128 * make "git cat-file --batch" detect unlinked packfiles so we don't
 129   have to restart processes (very long-term)
 130
 131 * linter to check validity of config file
 132
 133 * linter option and WWW endpoint to graph relationships and flows
 134   between inboxes, addresses, Maildirs, coderepos, newsgroups,
 135   IMAP mailboxes, etc...
 136
 137 * pygments support - via Python script similar to `git cat-file --batch'
 138   to avoid startup penalty.  pygments.rb (Ruby) can be inspiration, too.
 139
 140 * highlighting + linkification for "git format-patch --interdiff" output
 141
 142 * highlighting for "git format-patch --range-diff" output
 143   (linkification is too expensive, as it requires mirroring)
 144
 145 * support UUCP addresses for legacy archives
 146
 147 * support pipelining as an IMAP/NNTP client for -watch + lei
 148
 149 * expose lei contents via read/write IMAP/JMAP server for personal use
 150
 151 * git SHA-256 migration/coexistence path