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
  10 * mailmap support (same as git) for remapping expired email addresses
  11
  12 * POP3 server, since some webmail providers support external POP3:
  13   https://public-inbox.org/meta/20160411034104.GA7817@dcvr.yhbt.net/
  14   Perhaps make this depend solely the NNTP server and work as a proxy.
  15   Meaning users can run this without needing a full copy of the
  16   archives in a git repository.
  17
  18 * HTTP and NNTP proxy support.  Allow us to be a frontend for
  19   firewalled off (or Tor-exclusive) instances.  The use case is
  20   for offering a publically accessible IP with a cheap VPS,
  21   yet storing large amounts of data on computers without a
  22   public IP behind a home Internet connection.
  23
  24 * DHT (distributed hash table) for mapping Message-IDs to various
  25   archive locations to avoid SPOF.
  26
  27 * optional Cache::FastMmap support so production deployments won't
  28   need Varnish (Varnish doesn't protect NNTP, either)
  29
  30 * dogfood and take advantage of new kernel APIs (while maintaining
  31   portability to older Linux, free BSDs and maybe Hurd).
  32
  33 * dogfood latest Xapian, Perl5, SQLite, git and various modules to
  34   ensure things continue working as they should (or more better)
  35   while retaining compatibility with old versions.
  36
  37 * Support more of RFC 3977 (NNTP)
  38
  39 * Combined "super server" for NNTP/HTTP/POP3 to reduce memory overhead
  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.org 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 * streaming Email::MIME replacement: currently we generate many
  72   allocations/strings for headers we never look at and slurp
  73   entire message bodies into memory.
  74   (this is pie-in-the-sky territory...)
  75
  76 * use REQUEST_URI properly for CGI / mod_perl2 compatibility
  77   with Message-IDs which include '%' (done?)
  78
  79 * more and better test cases (use git fast-import to speed up creation)
  80
  81 * large mbox/Maildir/MH/NNTP spool import (see PublicInbox::Import)
  82
  83 * Read-only WebDAV interface to the git repo so it can be mounted
  84   via davfs2 or fusedav to avoid full clones.
  85   davfs2 needs Range: request support for this to be feasible:
  86     https://savannah.nongnu.org/bugs/?33259
  87     https://savannah.nongnu.org/support/?107649
  88
  89 * Contribute something like IMAP IDLE for "git fetch".
  90   Inboxes (and any git repos) can be kept up-to-date without
  91   relying on polling.
  92
  93 * Improve bundle support in git to make it cheaper to host/clone
  94   with dumb HTTP(S) servers.
  95
  96 * Expose targeted reindexing of individual messages.
  97   Sometimes an indexing bug only affects a handful of messages,
  98   so it's not worth the trouble of doing a full reindex.
  99
 100 * code repository integration (with cgit, gitweb, etc...)
 101
 102 * migration path to v2 without breaking v1 "git fetch" cronjobs
 103
 104 * imperfect scraper importers for obfuscated list archives
 105   (e.g. obfuscated Mailman stuff, Google Groups, etc...)
 106
 107 * consider using HTTP::Date instead of Date::Parse, since we need the
 108   former is capable of parsing RFC822-ish dates, used by Plack, and
 109   the latter is missing from OpenBSD and maybe other distros.
 110
 111 * improve performance and avoid head-of-line blocking on slow storage
 112
 113 * share "git cat-file --batch" processes across inboxes to avoid
 114   bumping into /proc/sys/fs/pipe-user-pages-* limits
 115
 116 * make "git cat-file --batch" detect unlinked packfiles so we don't
 117   have to restart processes (very long-term)
 118
 119 * support searching based on `git-patch-id --stable` to improve
 120   bidirectional mapping of commits <=> emails
 121
 122 * linter to check validity of config file
 123
 124 * linter option and WWW endpoint to graph relationships and flows
 125   between inboxes, addresses maildirs, coderepos, etc...
 126
 127 * pygments support - via Python script similar to `git cat-file --batch'
 128   to avoid startup penalty.  pygments.rb (Ruby) can be inspiration, too.
 129
 130 * highlighting + linkification for "git format-patch --interdiff" output
 131
 132 * highlighting + linkification for "git format-patch --range-diff" output
 133   (requires mirroring of git repos)
 134
 135 * parse and allow (semi)automatic-mirroring of "git request-pull" output
 136   for coderepos
 137
 138 * configurable diff output for solver-generated blobs
 139
 140 * fix search for messages with multiple Subject:/To:/From:/Date:
 141   headers (some wacky examples out there...)