examples: add varnish-4.vcl

Well, I'm fumbling along with this config.  Might as well
fumble along with it publically :)

TODO: update documentation for performance items

view: avoid redundant trailing slash for In-Reply-To

Oops, fortunately this branch is only exposed to non-Xapian
users, right now.

address: filter out domain from address-as-name idents

It seems common for address entries to end up as:
"foo@example" <foo@example>

Avoid needlessly displaying the domain name in that case.

examples/README: update URL to point to our HTTPS backend

It's browseable, too!

t/watch_maildir: quiet down spam check warning

Probably better than bloating our own API with configurable
warning streams and such...

www_stream: fix stupid typo :x

Note to self: remember to run tests

Fixes: 52052329aced ("git: allow cloning from the URL root, too")

git: allow cloning from the URL root, too

This means we can still show non-git users a somewhat browseable
URL with a link to the README.html file while allowing git users
to type less when cloning.

All of the following are supported:

git clone https://public-inbox.org/ public-inbox
git clone https://public-inbox.org/public-inbox
git clone https://public-inbox.org/public-inbox.git
torsocks git clone http://ou63pmih66umazou.onion/public-inbox

update git repo location to https:// using GitHTTPBackend.pm

Might as well eat our own dogfood...

githttpbackend: allow git to be a regular scalar string

No point in forcing users to pass a hashref/object to
get a single git directory.

searchview: add missing newline in search results

Hrm... is there a more obvious way to do an internal API for
this while still being streamable?

www_stream: fix search for new.html endpoint

We want to avoid the bare './' wherever possible, but it
doesn't seem possible here.

view: fix permalink and raw links at the top

Oops :x  I really need to whip check-inbox.perl into
shape or at least start running it, again.

Fixes: e29518088b3f ("view: fix up some HTML injection via Message-ID vectors")

view: move per-message anchor to top in conversation view

This fixes the '^' (up) link in the $INBOX/new.html endpoint
for search-less displays.

searchview: show result count in thread index, for now

I'm not sure what to show here, actually; but it's better
than triggering an uninitialized variable warning.

view: reference posting style article on Wikipedia

Storage is precious when it is forever and distributed.

And public-inbox aims to not only end Eternal September(*),
but to build a world less-centralized than Usenet ever was:
forkable discussion groups

(*) https://en.wikipedia.org/wiki/Eternal_September

view: improve readability of msg_reply with here-doc

This should make formatting more apparent since we can rely
on <pre> semantics.

www_stream: add response wrapper sub

This encapsulates an entire PSGI response array, hopefully
making it easier to generate responses and avoid typos when
setting the Content-Type.

view: fixup bad reference to new_msgid

Oops, this endpoint needs testing :x

Merge branch 'thread-view-skel'

* thread-view-skel:
  view: show thread size when linking to summary
  view: default to flat/hybrid thread display
  view: fix up some HTML injection via Message-ID vectors
  www: reinstate old thread view as an option
  view: show more nearby messages in flat thread view
  view: tweak thread/index header slightly
  feed: add $INBOX/new.html endpoint
  view: merge $state hash with existing $ctx
  view: show thread context in the thread-aware flat view
  www: use WwwStream for dumping thread and search views
  www: implement hybrid flat+thread conversation view

view: show thread size when linking to summary

This should give readers a better idea of what to expect.

view: default to flat/hybrid thread display

This is friendlier for people on small screens and usually
eliminates the need to scroll horizontally.

view: fix up some HTML injection via Message-ID vectors

Oops, these were only introduced during the hybrid flat thread
view reworking and never deployed.

www: reinstate old thread view as an option

This hybrid view is better than the old flat, but can
still fall down compared to the old threaded view in
some cases.

Revert "view: update git-send-email URL"

This reverts commit a391cf5aaf7181b5e5e20eb240c7ce50cbdf8fa2
as kernel.org is updating again.  Ref:
http://mid.gmane.org/xmqqpor18a2n.fsf@gitster.mtv.corp.google.com

view: show more nearby messages in flat thread view

Context is important, but so is conserving precious screen
space.  Decisions :<

view: tweak thread/index header slightly

This makes the top permalink/raw as well as the In-Reply-To
show up without search.  While we're at it, try to make
the links on the thread index from the "X siblings, Y replies"
more obvious.

feed: add $INBOX/new.html endpoint

This acts like the Atom feed; but should be viewable directly
from browsers.

view: merge $state hash with existing $ctx

This reduces the level of indirection to reach certain objects
within the hash and there are no namespace or lifetime conflicts
anyways.

view: show thread context in the thread-aware flat view

This lets user have a small window of the context of
the current message relative to other threads.

www: use WwwStream for dumping thread and search views

This allows us the HTTP server to react to backpressure
from slow clients when writing.  As a side effect, this
also makes it easier for us to maintain a consistent
header/footer across our HTML.

www: implement hybrid flat+thread conversation view

This should be more accessible to readers on narrow terminals
(or giant fonts) while providing a chronological view which
is also aware of message threading relationships.

view: HTML escape mailto: link

Oops, we cannot have bare '&' in mailto: links, either.

view: attribute in parent link for permalink message

Oops, but apparently this does not trigger errors?

inbox: avoid trying s// on undef

Oops, I guess I'm trigger-happy today.

Fixes: 31a6ff1221fe ("inbox: ensure we do not show leading "From " lines")

inbox: ensure we do not show leading "From " lines

Some messages will be misimported due to an old bug,
clean them up and ensure we do not propagate the mistake.

Followup-to: a0c07cba0e5d ("mda: drop leading "From " lines again")

mda: drop leading "From " lines again

Oops...

While we're at it, drop blank lines before the "From ", too,
since it could happen.

spamcheck/spamc: fix compatibility with Perl 5.14.2

This is necessary for Debian 7.x (wheezy), since
GLOB objects do not seem responsive to the can("fileno")
check (we do a similar check in GitHTTPBackend).

watch_maildir: warn on spam check failures

It would be nice to know about spamcheck failures.

www: unescape '+' in query parameter to space

Fixes: fbcb7de93884b ("www: remove a few more Plack::Request dependencies")

TODO: add a few Xapian-related items

"git cat-file --batch" seems expensive for big repos and
loading 70K+ tree objects in git isn't all that fast.

Ideas are cheap, time, code, and testing are not :P

www_stream: linkify cloneurl entries if they're HTTP/HTTPS

They may be other public-inbox instances which are browseable,
so provide a link to them to encourage their use as clones.

view: safer and optional quoting for --in-reply-to arg

Angle brackets around the --in-reply-to= arg for git send-email
has been optional since git v1.5.3.2, so strip them and make the
command-line argument easier-to-type.

address: remove Address::from_name

Address::names is sufficient to handle what from_name did.

view: show To/Cc destinations in conversation view

It is important to show the decentralized nature of
communication in our web views.

address: beef up the module with name list extaction

We may remove from_name in the future.

...And disallow quotes in email addresses.
Technically I believe they're allowed, but they're definitely
uncommon and unlikely to show up in legitimate mail.

inbox: do not weaken already-weak refs

This quiets a (hopefully harmless) warning when a ref remains
alive through several expiry timeouts.

http: cork chunked responses for small savings

This only affects Linux users with MSG_MORE support.

We can avoid extra TCP overhead for sub-optimal chunk sizes
by using MSG_MORE even with chunk trailers under Linux.

This breaks real-time apps which require <= 200ms latency for
streaming small packets (e.g. implementing "tail -F"), but the
public-inbox WWW code does not (and will never) do such things.

mbox: reduce small packets for gzipped mboxes

We want to avoid sending 10 or 20-byte gzip headers as
separate TCP packets to reduce syscalls and avoid wasting
bandwidth.

githttpbackend: shallow clone workaround

Apparently git-http-backend exits with a non-zero
status on shallow clones (due to git-upload-pack),
so there is a to-be-fixed bug in git.git

http://mid.gmane.org/20160621112303.GA21973@dcvr.yhbt.net
http://mid.gmane.org/20160621121041.GA29156@sigill.intra.peff.net

evcleanup: micro-optimize asap function

Instead of relying on a timer with immediate callback,
arm a pipe to watch for writability, ensuring the callback
always fires.

http: always yield on getline/body

We want to maximize fairness for large responses which may
download the entire mbox.

watch_maildir: ignore Trash and Drafts, support Dovecot

Trashed messages and drafts are probably not intended for
importing, so do not import them.  Dovecot uses extra flags via
lowercase letters, so we must support those (as that's the
server I use).

watch_maildir: implement optional spam checking

Mailing lists I watch and mirror may not have the best spam
filtering, and an extra layer should not hurt.

watch_maildir: rename _check_spam => _remove_spam

We do not actually do spam checking, here; but will
do spam checking before adding a message in the future.

document Filesys::Notify::Simple dependency

And improve documentation for existing dependencies, too.

split out spamcheck/spamc to its own module.

This should hopefully make it easier to try other anti-spam
systems (or none at all) in the future.

implement ListMirror SpamAssassin plugin

When running mailing list mirrors, one needs to be careful
spammers do not try to sidestep the list server we want to
mirror from and inject email into our mail directly by setting
the appropriate list headers (e.g. "X-Mailing-List" or
"List-Id").  We trust the top-most Received: header is
the one our own mail server got the mail from.

Bcc:-ing a public mailing list is a very likely indicator of
spam in my experience, so throw in an extra rule mark it.
While public-inbox-mda rejects Bcc: entirely, public-inbox-watch
needs to mirror lists which allow Bcc.

==> list_mirror.cf <==
loadplugin PublicInbox::SaPlugin::ListMirror

ifplugin PublicInbox::SaPlugin::ListMirror
  header LIST_MIRROR_RECEIVED eval:check_list_mirror_received()
  describe LIST_MIRROR_RECEIVED Received does not match trusted list server
  score LIST_MIRROR_RECEIVED 10

  header LIST_MIRROR_BCC eval:check_list_mirror_bcc()
  describe LIST_MIRROR_BCC Mailing list was Bcc-ed
  score LIST_MIRROR_BCC 1
endif

==> ~/.spamassassin/user_prefs <==
ifplugin PublicInbox::SaPlugin::ListMirror
  list_mirror X-Mailing-List git@vger.kernel.org *.kernel.org git@vger.kernel.org
endif

view: update git-send-email URL

I've setup my own mirror on https://git-htmldocs.bogomips.org/
since kernel.org is no longer updated, and I don't believe
in endorsing commercial hosting sites or interests.

Unfortunately, it still contains JavaScript and CSS, but it's
generated by AsciiDoc.  Oh well, it's all Free Software, at
least.

Junio C Hamano writes:
> On Wed, Jun 22, 2016 at 12:00 PM, Eric Wong <e@80x24.org> wrote:
> > Just wondering, who updates
> > https://kernel.org/pub/software/scm/git/docs/
> > and why hasn't it been updated in a while?
> > (currently it says Last updated 2015-06-06 at the bottom)
>
> Nobody. It is too cumbersome to use their upload tool to update many
> files (it is geared towards updating a handful of tarballs at a time).

ref:
http://mid.gmane.org/20160622190018.GA786@dcvr.yhbt.net/
http://mid.gmane.org/CAPc5daUiUv-EEv7ouQ=K+Q8S64QVV5wn4H6+TuF0wLeo123K5Q@mail.gmail.com
http://mid.gmane.org/20160622214811.GA19633@dcvr.yhbt.net

view: allow thread generation to EOF on errors

We want to ensure the actual message gets shown, and less
important info does not destroy things.

view: fix topic threading when ghosts are present

This fixes a bug where a message replying to a ghost would
accidentally be added to the wrong topic in the index/topic
view.

Before commit 76d8f68dc273e54809ad69cfe49e141003f790ef ("view:
avoid recursion in topic index"), we would refuse to indent a
topic which started with a ghost which hid the problem.  Now we
inform the user the thread started elsewhere.

view: support non-existent Subjects for permalink titles

Showing "(no subject)" seems like a common fallback for
messages without a Subject header.

search: support Subject:-less messages

Some mailing lists allow empty Subject headers and we shall support
searching and indexing them.

daemon: disable SIGWINCH unless explicitly daemonized

Checking stdin/stdout/stderr is not sufficient as the daemon
without setsid can still be under the control of a terminal.

Unfortunately this means systemd users cannot use SIGWINCH,
either.

searchidx: merge old thread id from ghosts

We failed to discard old thread IDs when vivifying ghosts
due to out-of-order message arrival.  This rectifies the
failure and will trigger a re-index.

searchidx: simplify ghost creation

Remove some worthless parameters and redundant no-ops
to make the next (important) patch easier-to-review.

view: common thread walking interface

Since we have a common pattern, for walking threads,
extract it into a function and reduce the amount of code
we haev.

This will make it easier to switch to an event-driven interface
for getline, too.

view: avoid recursion in topic index

Recursion can cause problems, so do our best to avoid it
even in the topic index.

searchview: remove recursion from thread view

As before, recursion can cause problems sooner than unshifting
objects into the head of a queue.

view: remove recursion from expanded thread view

This should let us generate HTML for arbitrarily deep
threads without blowing the stack.

How it renders on the client side is another matter...

view: remove recursion from thread skeleton dump

This should help prevent OOM errors from arbitrarily
deep threads and will make our streaming interface
easier-to-implement.

view: remove dst parameter from thread skeleton dump

We can stuff this into the state hash to reduce stack size and
hopefully improve readability.

view: remove upfx parameter from thread skeleton dump

This makes the string creation somewhat simpler hopefully
makes the code easier-to-reason with.

spawn: improve error checking for fork failures

fork failures are unfortunately common when Xapian has
gigabytes and gigabytes mmapped.

searchview: use inbox->msg_by_mid

This abstracts out the path lookup logic and and allow us
potentially allow different heads in the same repository.

We may also bypass slow tree name lookups in the future
by storing the raw blob ID in the Xapian document.

Followup-to: 4b313dc74bc9 ("feed: various object-orientation cleanups")

searchview: fix Atom dump

Ugh, and I will still need to write better tests for this
(and a billion other things :x)

Fixes: 4b313dc74bc9 ("feed: various object-orientation cleanups")

nntp: use lookup_mail instead of lookup_message

lookup_mail is safer since it won't inadvertently load ghosts.

www: improve topic view by scanning for ghosts

This should help avoid having too many fake top-level
messages in the topic view since we only have a partial
window for threading results.

address: remove quotes around names

They're needless for actual display once outside of email
headers.  But we will still show them when displaying mock
headers in the permalink view.

inbox: move field population logic to initializer

Inboxes are normally created by Config, but having the
population logic in Inbox should make it easier to mock
for testing.

feed: various object-orientation cleanups

Favor Inbox objects as our primary source of truth to simplify
our code.  This increases our coupling with PSGI to make it
easier to write tests in the future.

A lot of this code was originally designed to be usable
standalone without PSGI or CGI at all; but that might increase
development effort.

mbox: avoid write dependency for streaming

Prefer to return strings instead, so Content-Length can be
calculated for caching and such.

mbox: remove feed dependency

We do not need feed options there (or anywhere, hopefully).

feed: remove dependence on fh->write for streaming

We'll be switching to a getline/close response body
to give the HTTP server more control when dealing
with slow clients.

feed: avoid needless method dispatches on 404

We overuse streaming, here.  Allow Content-Length to be
calculated in this case.

MANIFEST: update with recent changes

And add a check-manifest target to the Makefile to
ensure we're up-to-date with git (but do not depend on
git).

examples/*@.service: wait one day for graceful shutdown

Because sometimes folks will want to download gigantic mboxes
or make large clones over Tor which are not resume-friendly.

Note: the timeout logic in nntpd is somewhat over-aggressive
and can break some large slrnpulls.  This ought to be easily
recoverable on the client-side, though, since it's based on
per-message fetches.

search: reopen and retry on updated databases

This seems like a nasty thing which breaks downloads of
large mailboxes.

http: constrain getline/close responses by time

This allows us to yield control to other clients gracefully if
getline takes too long to generate a chunk.  This is more
expensive but should not cost a syscall on modern 64-bit systems.

http: avoid recursion when hitting write count limit

Use the EvCleanup::asap handler to reschedule our writes
after yielding to other clients.

mbox: set gzip timestamp to the Unix epoch

This allows consistency between different invocations from
roughly the same period and is no worse for caching any any of
our existing HTML and Atom feeds.

We cannot set the timestamp to the end date since messages
may be added to the repository while we are iterating
(and this streaming mechanism will pick them up).

watch_maildir: tighten up path checks

Only mark seen messages as spam, otherwise it could be
too aggressive and cause problems or over training.
We wouldn't want a wayward FIFO ruining our day, either :)

import: allow messages without subject

Because our WatchMaildir module is liberal about what
it accepts, we can potentially have messages without a
subject.

watch_maildir: spam removal support

We can support spam removal by watching a special "spam"
Maildir, too.  We can run public-inbox-learn as a separate
step, and that command will be improved to support
auto-learning, too.

watch_maildir: add scan test

This should be portable despite the intended use of this
directory being non-portable.

emergency: avoid needless mkpath dependency

Be more explicit and slightly speed up tests.

daemon: be less misleading about graceful shutdown

We do not need to count the httpd.async object
against our running client count, that is tied to
the socket of the actual client.

This prevents misleading sysadmins about connected
clients during shutdown.

spawn: try to keep signals blocked in spawned child

While we only want to stop our daemons and gracefully destroy
subprocesses, it is common for 'Ctrl-C' from a terminal to kill
the entire pgroup.

Killing an entire pgroup nukes subprocesses like git-upload-pack
breaks graceful shutdown on long clones.  Make a best effort to
ensure git-upload-pack processes are not broken when somebody
signals an entire process group.

Followup-to: commit 37bf2db81bbbe114d7fc5a00e30d3d5a6fa74de5
("doc: systemd examples should only kill one process")

view: consolidate per-message newline handling

We don't want to blindly append a trailing newline
if the message ends in quoted text leading to a <span>,
as a newline is already added to a <span>...

view: minor tweaks to reduce long lines

Fold addressee fields to better delimit destinations,
reduce horizontal rule <hr /> to reduce scrolling,
and use spaces to indent "git send-email" example.