]> Sergey Matveev's repositories - public-inbox.git/blobdiff - TODO
No ext_urls
[public-inbox.git] / TODO
diff --git a/TODO b/TODO
index 605013e4904baabecd4a0a55997aebd8e8477a8f..1537179e536f2c50709eae629b6ee39ee822764c 100644 (file)
--- a/TODO
+++ b/TODO
@@ -5,40 +5,47 @@ performance, ease-of-setup, installation, maintainability, etc
 all need to be considered for everything we introduce)
 
 * general performance improvements, but without relying on
-  XS or compiled code any more than we currently do.
+  XS or pre-built modules any more than we currently do.
+  (Optional Inline::C and user-compiled re2c acceptable)
 
 * mailmap support (same as git) for remapping expired email addresses
 
-* POP3 server, since some webmail providers support external POP3:
-  https://public-inbox.org/meta/20160411034104.GA7817@dcvr.yhbt.net/
-  Perhaps make this depend solely the NNTP server and work as a proxy.
-  Meaning users can run this without needing a full copy of the
-  archives in a git repository.
+* support remapping of expired URLs similar to mailmap
+  (coordinate with git.git with this?)
 
-* HTTP and NNTP proxy support.  Allow us to be a frontend for
+* HTTP, IMAP, NNTP, POP3 proxy support.  Allow us to be a frontend for
   firewalled off (or Tor-exclusive) instances.  The use case is
-  for offering a publically accessible IP with a cheap VPS,
+  for offering a publicly accessible IP with a cheap VPS,
   yet storing large amounts of data on computers without a
   public IP behind a home Internet connection.
 
-* TLS support for various daemons (including STARTTLS for NNTP and POP3)
+* support HTTP(S) CONNECT proxying to IMAP/NNTP/POP3 for users with
+  firewall problems
 
-* NNTP COMPRESS extension (see innd)
+* DHT (distributed hash table) for mapping Message-IDs to various
+  archive locations to avoid SPOF.
 
-* Combined "super server" for NNTP/HTTP/POP3 to reduce memory overhead
+* optional Cache::FastMmap support so production deployments won't
+  need Varnish (Varnish doesn't protect NNTP nor IMAP, either)
 
-* Optional reply-to-list support for mirroring lists that want it :<
-  Reply-to-list encourages the existing list as a single-point-of-failure,
-  but having an extra mirror using public-inbox code is nice regardless.
+* dogfood and take advantage of new kernel APIs (while maintaining
+  portability to older Linux, free BSDs and maybe Hurd).
 
-* Optional reply-to-nobody for dead lists.
+* dogfood latest Xapian, Perl5, SQLite, git and various modules to
+  ensure things continue working as they should (or more better)
+  while retaining compatibility with old versions.
+
+* Support more of RFC 3977 (NNTP)
+  Is there anything left for read-only support?
 
 * Configurable linkification for per-inbox shorthands:
   "$gmane/123456" could be configured to expand to the
-  appropriate link pointing to the gmane.org list archives,
+  appropriate link pointing to the gmane.io list archives,
   likewise "[Bug #123456]" could be configured to expand to
   point to some project's bug tracker at http://example.com/bug/123456
 
+* configurable synonym and spelling support in Xapian
+
 * Support optional "HTTPS Everywhere" for mapping old HTTP to HTTPS
   links if (and only if) the user wants to use HTTPS.  We may also
   be able to configure redirects for expired URLs.
@@ -49,63 +56,105 @@ all need to be considered for everything we introduce)
 
 * configurable constants (index limits, search results)
 
-* handle messages with multiple Message-IDs (how?)
+* handle messages with multiple Message-IDs (done for v2, doable for v1)
 
 * handle broken double-bracketed References properly (maybe)
   and totally broken Message-IDs
 
   cf.  https://public-inbox.org/git/20160814012706.GA18784@starla/
 
-* portability to FreeBSD (and other Free Software *BSDs)
-  ugh... https://rt.cpan.org/Ticket/Display.html?id=116615
-  (IO::KQueue is broken with Danga::Socket)
-
 * improve documentation
 
 * linkify thread skeletons better
   https://public-inbox.org/git/6E3699DEA672430CAEA6DEFEDE6918F4@PhilipOakley/
 
-* generate sample CSS for use with Stylish/dillo/etc
-
-* streaming Email::MIME replacement: currently we generate many
-  allocations/strings for headers we never look at and slurp
-  entire message bodies into memory.
-  (this is pie-in-the-sky territory...)
+* Further lower mail parser memory usage.  We still slurp entire
+  message bodies into memory and incur 2-3x overhead on
+  multipart messages.  Inline::C (and maybe gmime) could work.
 
 * use REQUEST_URI properly for CGI / mod_perl2 compatibility
   with Message-IDs which include '%' (done?)
 
-* more and better test cases (use git fast-import to speed up creation)
+* better test cases, make faster by reusing more setup
+  code across tests
+
+* large mbox/Maildir/MH/NNTP spool import (in lei, but not
+  for public-facing inboxes)
 
-* large mbox/Maildir/MH/NNTP spool import (see PublicInbox::Import)
+* MH import support (read-only, at least)
 
 * Read-only WebDAV interface to the git repo so it can be mounted
   via davfs2 or fusedav to avoid full clones.
+  davfs2 needs Range: request support for this to be feasible:
+    https://savannah.nongnu.org/bugs/?33259
+    https://savannah.nongnu.org/support/?107649
+
+* Contribute something like IMAP IDLE for "git fetch".
+  Inboxes (and any git repos) can be kept up-to-date without
+  relying on polling.
+
+* Improve bundle support in git to make it cheaper to host/clone
+  with dumb HTTP(S) servers.
+
+* Expose targeted reindexing of individual messages.
+  Sometimes an indexing bug only affects a handful of messages,
+  so it's not worth the trouble of doing a full reindex.
+
+* code repository integration (cgit: done, TODO: gitweb, etc...)
+
+* migration path to v2 (making it transparent for "git fetch"
+  may not be possible, but "public-inbox-fetch" will handle it)
+
+* imperfect scraper importers for obfuscated list archives
+  (e.g. obfuscated Mailman stuff, Google Groups, etc...)
+
+* improve performance and avoid head-of-line blocking on slow storage
+  (done for most git blob retrievals, Xapian needs work)
+
+* allow optional use of separate Xapian worker process to implement
+  timeouts and avoid head-of-line blocking problems.  Consider
+  just-ahead-of-time builds to take advantage of custom date parsers
+  (approxidate) and other features not available to Perl bindings.
+
+* integrate git approxidate parsing into Xapian w/o spawning git
+
+* HTTP(S) search API (likely JMAP, but GraphQL could be an option)
+  It should support git-specific prefixes (dfpre:, dfpost:, dfn:, etc)
+  as extensions.  If JMAP, it should have HTTP(S) analogues to
+  various IMAP extensions.
+
+* scalability to tens/hundreds of thousands of inboxes
+
+  - inotify-based manifest.js.gz updates
+
+  ...
+
+* lei - see %CMD in lib/PublicInbox/LEI.pm
+  (there's a truckload here..)
+
+* make "git cat-file --batch" detect unlinked packfiles so we don't
+  have to restart processes (very long-term)
 
-* Improve tree layout to help giant archives (v2 format):
+* linter to check validity of config file
 
-  * Must be optional; old ssoma users may continue using v1
+* linter option and WWW endpoint to graph relationships and flows
+  between inboxes, addresses, Maildirs, coderepos, newsgroups,
+  IMAP mailboxes, etc...
 
-  * Xapian becomes becomes a requirement when using v2; they
-    claim good scalability: https://xapian.org/docs/scalability.html
+* pygments support - via Python script similar to `git cat-file --batch'
+  to avoid startup penalty.  pygments.rb (Ruby) can be inspiration, too.
 
-  * Allow git to perform better deltafication for quoted messages
+* highlighting + linkification for "git format-patch --interdiff" output
 
-  * Changing tree layout for deltafication means we need to handle
-    deletes for spam differently than we do now.
+* highlighting for "git format-patch --range-diff" output
+  (linkification is too expensive, as it requires mirroring)
 
-  * Deal with duplicate Message-IDs (web UI, at least, not sure about NNTP)
+* support UUCP addresses for legacy archives
 
-  * (Maybe) SQLite alternatives (MySQL/MariaDB/Pg) for NNTP article
-    number mapping: https://www.sqlite.org/whentouse.html
+* support pipelining as an IMAP/NNTP client for -watch + lei
 
-  * Ref rotation (splitting heads by YYYY or YYYY-MM)
+* expose lei contents via read/write IMAP/JMAP server for personal use
 
-  * Support multiple git repos for a single archive?
-    This seems gross, but splitting large packs in in git conflicts
-    with bitmaps and we want to use both features.  Perhaps this
-    limitation can be fixed in git instead of merely being documented:
-    https://public-inbox.org/git/20160428072854.GA5252@dcvr.yhbt.net/
+* git SHA-256 migration/coexistence path
 
-  * Optional history squashing to reduce commit and intermediate
-    tree objects
+* decode RFC 3676 format=flowed + DelSp properly (see mflow (mblaze), mutt, ...)