]> Sergey Matveev's repositories - public-inbox.git/log
public-inbox.git
2 years agodoc: lei-index: remove --stdin, reword -F
Eric Wong [Fri, 24 Sep 2021 12:51:08 +0000 (12:51 +0000)]
doc: lei-index: remove --stdin, reword -F

lei-index really only works for Maildir, at the moment.

2 years agodoc: lei-overview: implicit stdin, correct Inline::C notes
Eric Wong [Fri, 24 Sep 2021 12:51:07 +0000 (12:51 +0000)]
doc: lei-overview: implicit stdin, correct Inline::C notes

Implicit stdin based on standard input being a pipe or regular
file is here to stay, so save users the trouble of typing '-'
or '--stdin'.

Inline::C is required as of commit 1d6e1f9a6a66 (lei: require
Socket::MsgHdr or Inline::C, drop oneshot, 2021-05-26); but
Socket::MsgHdr still gives a noticeable improvement in bash
completion speed.

Also, spell-out "MESSAGE-ID" since "MID" is actually not a
common abbreviation ("MSGID" is used by RFC 3977 and several
other RFCs, I recall).

2 years agodoc: lei blob+rediff+p2q: add notes about git directory
Eric Wong [Fri, 24 Sep 2021 12:51:06 +0000 (12:51 +0000)]
doc: lei blob+rediff+p2q: add notes about git directory

Try to clarify these commands are intended to be useful for
git-using (usually software) projects (and not the bare git
repos we use internally).

We'll also document some commonly useful git-diff switches
in the lei-rediff man page to highlight the usefulness
of the command.

2 years agot/v2mirror: check dependencies for legacy test
Eric Wong [Sat, 25 Sep 2021 03:21:01 +0000 (03:21 +0000)]
t/v2mirror: check dependencies for legacy test

We still need Email::MIME to test against old revisions.
We'll also depend on the revision just prior to the
manifest.js.gz introduction to avoid loading Danga::Socket,
since it was getting loaded even with `plackup'.

Finally, we'll disable Inline::C usage with old Spawn.pm
since our old code included alloca.h, which is not
portable to FreeBSD.

2 years agofetch: support v2 w/o manifest on old WWW
Eric Wong [Fri, 24 Sep 2021 10:56:45 +0000 (10:56 +0000)]
fetch: support v2 w/o manifest on old WWW

There may still be pre-manifest.js.gz versions of
PublicInbox::WWW running and serving v2 inboxes.

While -clone and "add-external --mirror" were working, -fetch
was failing due to 301 redirect to $INBOX_URL/manifest.js.gz/
and not the expected 404.  Update the code to deal with a JSON
decode error (from the 301) and ensure v2 epochs detection is
correct (and not using a shadowed variable).

2 years agoclone|fetch|--mirror: cull manifest in partial mirrors
Eric Wong [Fri, 24 Sep 2021 10:56:44 +0000 (10:56 +0000)]
clone|fetch|--mirror: cull manifest in partial mirrors

This makes it easier for users to enable fetching on a
previously read-only epoch.  Prior to this change, users were
required to delete manifest.js.gz in addition to adding the
writable bit.  Now, they just have to "chmod +w $EPOCH_DIR".

2 years agoclone|--mirror: fix and test against pre-manifest WWW
Eric Wong [Fri, 24 Sep 2021 10:56:43 +0000 (10:56 +0000)]
clone|--mirror: fix and test against pre-manifest WWW

There may still be pre-manifest.js.gz versions of PublicInbox::WWW.
running and serving v2 inboxes.

Since $INBOX_URL/manifest.js.gz was not understood, it was
assumed to be a Message-ID and 301-ed to
"$INBOX_URL/manifest.js.gz/" with a trailing slash, so our 404
checks were invalid.  Update our fallbacks to deal with 301
by catching JSON decoding errors to trigger HTML scraping.

For HTML parsing, be sure to not be fooled by potential
user-generated content and only scan the part after the last
<hr>.

We also need to avoid propagating $? from curl unnecessarily
when we can continue safely.

Finally, update v2mirror.t with tests to use PublicInbox::WWW
from our "v1.1.0-pre1" tag to ensure these code paths get tested

2 years agofetch: fix skipping with multi-epoch inboxes
Eric Wong [Fri, 24 Sep 2021 10:56:42 +0000 (10:56 +0000)]
fetch: fix skipping with multi-epoch inboxes

We need to check every epoch for writability, so don't
break out of the loop when we find a URL.

2 years agoclone|--mirror: support --epoch=RANGE for partial clones
Eric Wong [Fri, 24 Sep 2021 10:56:41 +0000 (10:56 +0000)]
clone|--mirror: support --epoch=RANGE for partial clones

Partial (v2) clones should be useful addition for users wanting
to conserve storage while having fast access to recent messages.

Continuing work started in 876e74283ff3 (fetch: ignore
non-writable epoch dirs, 2021-09-17), this creates bare,
read-only epoch git repos.  These git repos have the remotes
pre-configured, but does not fetch any objects.

The goal is to allow users to set the writable bit on a
previously-skipped epoch and start fetching it.

Shell completion support may not be necessary given how short
the epoch ranges are, here.

Cc: Luis Chamberlain <mcgrof@kernel.org>
Link: https://public-inbox.org/meta/20210917002204.GA13112@dcvr/T/#u
2 years agolei_xsearch: use localtime for user message
Eric Wong [Thu, 23 Sep 2021 10:37:42 +0000 (10:37 +0000)]
lei_xsearch: use localtime for user message

It's probably least confusing for user-facing messages to
display times in the user's configured timezone.  I considered
appending "UTC" to the message and sticking with gmtime(), too,
but this output isn't intended to be web-cache friendly nor
expect users from across multiple timezones to view the same
output.

2 years agolei: common --all[=remote|local] help message
Eric Wong [Thu, 23 Sep 2021 10:36:22 +0000 (10:36 +0000)]
lei: common --all[=remote|local] help message

It helps to be consistent and reduce the learning curve, here.

2 years agoxcpdb: avoid race when shards are added
Eric Wong [Thu, 23 Sep 2021 05:53:03 +0000 (05:53 +0000)]
xcpdb: avoid race when shards are added

It's possible for the rename() sequence to cause read-only
daemons using ->xdb_shards_flat to load an incomplete set of
contiguous shards and get invalid docids for search results.

With this change, we favor the case where search is momentarily
unavailable rather than giving wrong results during the small
window where Xapcmd->commit_changes runs.

2 years agoxcpdb: -R$SHARDS creates new shards with correct perms
Eric Wong [Thu, 23 Sep 2021 05:53:02 +0000 (05:53 +0000)]
xcpdb: -R$SHARDS creates new shards with correct perms

"Correct" meaning the permissions match that of the parent
xap15 or ei15 directory.

2 years agotest_common: reset umask on non-forking run_script
Eric Wong [Thu, 23 Sep 2021 05:53:01 +0000 (05:53 +0000)]
test_common: reset umask on non-forking run_script

public-inbox-init sets umask for git <2.1.0, so our fork+exec
replacement needs to restore the original umask of the "parent".

2 years agodaemons: revamp periodic cleanup task
Eric Wong [Thu, 23 Sep 2021 00:46:25 +0000 (00:46 +0000)]
daemons: revamp periodic cleanup task

Neither Inboxes nor ExtSearch objects were retrying correctly
when there are live git processes, but the inboxes were getting
rescanned for search or other reasons.  Ensure the scan retries
eventually if there's live processes.

We also need to update the cleanup task to detect Xapian shard
count changes, since Xapian ->reopen is enough to detect any
other Xapian changes.  Otherwise, we just issue an inexpensive
->reopen call and let Xapian check whether there's anything
worth reopening.

This also lets us eliminate the Devel::Peek dependency.

2 years agogcf2 + extsearch: check for unlinked files on Linux
Eric Wong [Wed, 22 Sep 2021 09:45:17 +0000 (09:45 +0000)]
gcf2 + extsearch: check for unlinked files on Linux

Check for unlinked mmap-ed files via /proc/$PID/maps every 60s
or so.

ExtSearch (extindex) is compatible-enough with Inbox objects to
be wired into the old per-inbox code, but the startup cost is
projected to be much higher down the line when there's >30K
inboxes, so we scan /proc/$PID/maps for deleted files before
unlinking.  With old Inbox objects, it was (and is) simpler to
just kill processes w/o checking due to the low startup cost
(and non-portability of checking).

Reported-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://public-inbox.org/meta/20210921144754.gulkneuulzo27qbw@meerkat.local/
2 years agolei: drop redundant WQ EOF callbacks
Eric Wong [Wed, 22 Sep 2021 02:24:35 +0000 (02:24 +0000)]
lei: drop redundant WQ EOF callbacks

Redundant code is noise and therefore confusing :<

2 years agolei up: avoid excessively parallel --all
Eric Wong [Wed, 22 Sep 2021 02:24:34 +0000 (02:24 +0000)]
lei up: avoid excessively parallel --all

We shouldn't dispatch all outputs right away since they
can be expensive CPU-wise.  Instead, rely on DESTROY to
trigger further redispatches.

This also fixes a circular reference bug for the single-output
case that could lead to a leftover script/lei after MUA exit.

I'm not sure how --jobs/-j should work when the actual xsearch
and lei2mail has it's own parallelism ("--jobs=$X,$M"), but
it's better than having thousands of subtasks running.

Fixes: b34a267efff7b831 ("lei up: fix --mua with single output")
2 years agoinbox: do not waste hash slot on httpbackend_limiter
Eric Wong [Wed, 22 Sep 2021 02:24:33 +0000 (02:24 +0000)]
inbox: do not waste hash slot on httpbackend_limiter

A few dozen bytes saved here can add up when we have thousands
of inboxes.  It also makes Data::Dumper debug output a bit cleaner.

2 years agolei: dclose: do not close unnecessarily
Eric Wong [Wed, 22 Sep 2021 02:24:32 +0000 (02:24 +0000)]
lei: dclose: do not close unnecessarily

The bit about reap_compress is no longer true since
LeiXSearch->query_done triggers it, instead.  I only noticed
this while working on "lei up".

2 years agoscript/lei: describe purpose of sleep loop
Eric Wong [Wed, 22 Sep 2021 02:24:31 +0000 (02:24 +0000)]
script/lei: describe purpose of sleep loop

It looks dumb, but I'm not about to take a runtime penalty to
use signalfd|EVFILT_SIGNAL, here, either.

2 years agotreewide: fix %SIG localization, harder
Eric Wong [Wed, 22 Sep 2021 02:24:30 +0000 (02:24 +0000)]
treewide: fix %SIG localization, harder

This fixes the occasional t/lei-sigpipe.t infinite loop
under "make check-run".

Link: http://nntp.perl.org/group/perl.perl5.porters/258784
  <CAHhgV8hPbcmkzWizp6Vijw921M5BOXixj4+zTh3nRS9vRBYk8w@mail.gmail.com>
Followup-to: b552bb9150775fe4 ("daemon+watch: fix localization of %SIG for non-signalfd users")
2 years agoipc: do not add "0" to $0 of solo workers
Eric Wong [Wed, 22 Sep 2021 02:24:29 +0000 (02:24 +0000)]
ipc: do not add "0" to $0 of solo workers

It's needless noise and misleads users reading "ps" into
thinking there's more workers when there's only one.

2 years agolei: umask(077) before opening errors.log
Eric Wong [Tue, 21 Sep 2021 09:29:45 +0000 (09:29 +0000)]
lei: umask(077) before opening errors.log

There's a chance some sensitive information (e.g. folder names)
can end up in errors.log, though $XDG_RUNTIME_DIR or
/tmp/lei-$UID/ will have 0700 permissions, anyways.

2 years agoscript/lei: handle SIGTSTP and SIGCONT
Eric Wong [Tue, 21 Sep 2021 09:29:44 +0000 (09:29 +0000)]
script/lei: handle SIGTSTP and SIGCONT

Sometimes it's useful to pause an expensive query or
refresh-mail-sync to do something else.  While lei-daemon and
lei/store can't be paused since they're shared across clients,
per-invocation WQ workers can be paused safely using the
unblockable SIGSTOP.

While we're at it, drop the ETOOMANYREFS hint since it
hasn't been a problem since we drastically reduced FD passing
early in development.

2 years agot/lei-up: use '-q' to silence non-redirected test
Eric Wong [Tue, 21 Sep 2021 09:29:43 +0000 (09:29 +0000)]
t/lei-up: use '-q' to silence non-redirected test

We could redirect, too, but just use -q since we don't care
for the output with run_mode => 0.

2 years agolei q: improve --limit behavior and progress
Eric Wong [Tue, 21 Sep 2021 07:41:59 +0000 (07:41 +0000)]
lei q: improve --limit behavior and progress

Avoid slurping gigantic (e.g. 100000) result sets into a single
response if a giant limit is specified, and instead use 10000
as a window for the mset with a given offset.  We'll also warn
and hint towards about the --limit= switch when the estimated
result set is larger than the default limit.

2 years agolei q: update messages to reflect --save default
Eric Wong [Tue, 21 Sep 2021 07:41:58 +0000 (07:41 +0000)]
lei q: update messages to reflect --save default

I wanted to try --dedupe=none for something, but it failed
since I forgot --no-save :x  So hint users towards --no-save
if necessary.

2 years agosearch: drop reopen retry message
Eric Wong [Tue, 21 Sep 2021 07:41:57 +0000 (07:41 +0000)]
search: drop reopen retry message

It's needless noise in syslogs for daemons and unnecessarily
alarming to users on the command-line.

2 years agolei q: show progress on >1s preparation phase
Eric Wong [Tue, 21 Sep 2021 07:41:56 +0000 (07:41 +0000)]
lei q: show progress on >1s preparation phase

Overwriting existing destinations safe (but slow) by default,
so show a progress message noting what we're doing while
a user waits.

2 years agolei: various completion improvements
Eric Wong [Tue, 21 Sep 2021 07:41:55 +0000 (07:41 +0000)]
lei: various completion improvements

"lei export-kw" no longer completes for anonymous sources.

More commands use "lei refresh-mail-sync" as a basis for their
completion work, as well.

";AUTH=ANONYMOUS@" is stripped from completions since it was
preventing bash completion from working on AUTH=ANONYMOUS IMAP
URLs.  I'm not sure if there's a better way, but all of our code
works fine without specifying AUTH=ANONYMOUS as a command-line
arg.

Finally, we fallback to using more candidates if none can
be found, allowing multiple URLs to be completed.

2 years agolei lcat: support NNTP URLs
Eric Wong [Tue, 21 Sep 2021 07:41:54 +0000 (07:41 +0000)]
lei lcat: support NNTP URLs

NNTP URLs are probably more prevalent in public message archives
than IMAP URLs.

2 years agodoc: lei-security: section for WIP auth methods
Eric Wong [Tue, 21 Sep 2021 07:41:53 +0000 (07:41 +0000)]
doc: lei-security: section for WIP auth methods

Lots of stuff out there that becomes a pain to setup
configuration for and test...

2 years agolei lcat: use single queue for ordering
Eric Wong [Tue, 21 Sep 2021 07:41:52 +0000 (07:41 +0000)]
lei lcat: use single queue for ordering

If lcat-ing multiple argument types (blobs vs folders),
maintain the original order of the arguments instead of
dumping all blobs before folder contents.

2 years agolei: simplify internal arg2folder usage
Eric Wong [Tue, 21 Sep 2021 07:41:51 +0000 (07:41 +0000)]
lei: simplify internal arg2folder usage

We can set opt->{quiet} for (internal) 'note-event' command
to quiet ->qerr, since we use ->qerr everywhere else.  And
we'll just die() instead of setting a ->{fail} message, since
eval + die are more inline with the rest of our Perl code.

2 years agolei_mail_sync: account for non-unique cases
Eric Wong [Tue, 21 Sep 2021 07:41:50 +0000 (07:41 +0000)]
lei_mail_sync: account for non-unique cases

NNTP servers, IMAP servers, and various MUAs may recycle
"unique" identifiers due to software bugs or careless BOFHs.
Warn about them, but always be prepared to account for them.

2 years agolei inspect: support NNTP URLs
Eric Wong [Tue, 21 Sep 2021 07:41:49 +0000 (07:41 +0000)]
lei inspect: support NNTP URLs

No reason not to support them, since there's more
public-inbox-nntpd instances than -imapd instances,
currently.

2 years agolei inspect: convert to WQ worker
Eric Wong [Tue, 21 Sep 2021 07:41:48 +0000 (07:41 +0000)]
lei inspect: convert to WQ worker

Xapian and SQLite access can be slow when a DB is large and/or
on high-latency storage.

2 years agogcf2: fix loading at runtime
Eric Wong [Mon, 20 Sep 2021 13:00:33 +0000 (13:00 +0000)]
gcf2: fix loading at runtime

We need to waitpid synchronously on pkg-config to use $?.

When loading Gcf2 inside the event loop, implicit dwaitpid
done by PublicInbox::ProcessPipe would not call waitpid in
time to zero $?.  This was causing one of my -httpd to
occasionally fall back to git(1) instead of using Gcf2.

This was noted in:
Link: https://public-inbox.org/meta/20210914085322.25517-1-e@80x24.org/
2 years agonet_reader: NNTP: remove article numbers from mail_sync folders
Eric Wong [Sun, 19 Sep 2021 22:51:57 +0000 (17:51 -0500)]
net_reader: NNTP: remove article numbers from mail_sync folders

NNTP article numbers are stored separately from folder names
in mail_sync.sqlite3.

Recovering from this is optional, worse case is wasting
bandwidth refetching some messages.  To (optionally) recover
from this, use:

lei forget-mail-sync $URL_WITH_ARTNUMS

Some articles will be refetched on the next import, but
duplicate data won't be indexed in Xapian.

2 years agodoc: lei-config: document various knobs
Eric Wong [Sun, 19 Sep 2021 12:50:35 +0000 (12:50 +0000)]
doc: lei-config: document various knobs

It's still a work-in-progress, but the basic debug knob
comes in handy for new users; as does proxy support.

2 years agonet_reader: disallow imap.fetchBatchSize=0
Eric Wong [Sun, 19 Sep 2021 12:50:34 +0000 (12:50 +0000)]
net_reader: disallow imap.fetchBatchSize=0

A batch size of zero is nonsensical and causes infinite loops.

2 years agolei config --edit: use controlling terminal
Eric Wong [Sun, 19 Sep 2021 12:50:33 +0000 (12:50 +0000)]
lei config --edit: use controlling terminal

As with "lei edit-search", "lei config --edit" may
spawn an interactive editor which works best from
the terminal running script/lei.

So implement LeiConfig as a superclass of LeiEditSearch
so the two commands can share the same verification
hooks and retry logic.

2 years agonet_reader: no STARTTLS for IMAP localhost or onions
Eric Wong [Sun, 19 Sep 2021 12:50:32 +0000 (12:50 +0000)]
net_reader: no STARTTLS for IMAP localhost or onions

At least not by default, to match existing NNTP behavior.
Tor .onions are already encrypted, and there's no point
in encrypting traffic on localhost outside of testing.

2 years agowatch: use net_reader->mic_new wrapper for SOCKS+TLS
Eric Wong [Sun, 19 Sep 2021 12:50:31 +0000 (12:50 +0000)]
watch: use net_reader->mic_new wrapper for SOCKS+TLS

This brings -watch up to feature parity with lei with
SOCKS support.

2 years agoxt: add fsck script over over.sqlite3
Eric Wong [Sun, 19 Sep 2021 12:50:30 +0000 (12:50 +0000)]
xt: add fsck script over over.sqlite3

I'm not sure what caused it, but I've noticed two missing
messages that failed from "lei up" on an https:// external;
and I've also seen some duplicates in the past (which I
think I fixed...).

2 years agonet_reader: fix single NNTP article fetch, test ranges
Eric Wong [Sun, 19 Sep 2021 12:50:29 +0000 (12:50 +0000)]
net_reader: fix single NNTP article fetch, test ranges

While NNTP ranges was already working, fetching a single message
was broken.  We'll also simplify the code a bit and ensure
incremental synchronization is ignored when ranges are
specified.

2 years agolei ls-mail-source: pretty JSON support
Eric Wong [Sun, 19 Sep 2021 12:50:28 +0000 (12:50 +0000)]
lei ls-mail-source: pretty JSON support

As with other commands, we enable pretty JSON by default if
stdout is a terminal or if --pretty is specified.  While the
->pretty JSON output has excessive vertical whitespace, too many
lines is preferable to having everything on one line.

2 years agolei ls-mail-source: use "high"/"low" for NNTP
Eric Wong [Sun, 19 Sep 2021 12:50:27 +0000 (12:50 +0000)]
lei ls-mail-source: use "high"/"low" for NNTP

The meanings of "hwm" and "lwm" may not be obvious abbreviations
for (high|low) water mark descriptions used by RFC 3977.
"high" and "low" should be obvious to anyone.

2 years agolei: clamp internal worker processes to 4
Eric Wong [Sun, 19 Sep 2021 12:50:26 +0000 (12:50 +0000)]
lei: clamp internal worker processes to 4

"All" my CPUs is only 4, but it's probably ridiculous for
somebody with a 16-core system to have 16 processes for
accessing SQLite DBs.

We do the same thing in Pmdir for parallel Maildir access
(and V2Writable).

2 years agoipc: drop dynamic WQ process counts
Eric Wong [Sun, 19 Sep 2021 12:50:25 +0000 (12:50 +0000)]
ipc: drop dynamic WQ process counts

In retrospect, I don't think it's needed; and trying to wire up
a user interface for lei to manage process counts doesn't seem
worthwhile.  It could be resurrected for public-facing daemon
use in the future, but that's what version control systems are for.

This also lets us automatically avoid setting up broadcast
sockets

Followup-to: 7b7939d47b336fb7 ("lei: lock worker counts")
2 years agolei_xsearch: drop Data::Dumper use
Eric Wong [Sun, 19 Sep 2021 12:50:24 +0000 (12:50 +0000)]
lei_xsearch: drop Data::Dumper use

We're not using Data::Dumper for JSON output.

2 years agolei: simplify sto_done_request
Eric Wong [Sun, 19 Sep 2021 12:50:23 +0000 (12:50 +0000)]
lei: simplify sto_done_request

With the switch from pipes to sockets for lei-daemon =>
lei/store IPC, we can send the script/lei client socket to the
lei/store process and rely on reference counting in both Perl
and the kernel to persist the script/lei.

2 years agolei/store: use SOCK_SEQPACKET rather than pipe
Eric Wong [Sun, 19 Sep 2021 12:50:22 +0000 (12:50 +0000)]
lei/store: use SOCK_SEQPACKET rather than pipe

This has several advantages:

* no need to use ipc.lock to protect a pipe for non-atomic writes

* ability to pass FDs.  In another commit, this will let us
  simplify lei->sto_done_request and pass newly-created
  sockets to lei/store directly.

disadvantages:

- an extra pipe is required for rare messages over several
  hundred KB, this is probably a non-issue, though

The performance delta is unknown, but I expect shards
(which remain pipes) to be the primary bottleneck IPC-wise
for lei/store.

2 years agoipc: allow disabling broadcast for wq_workers
Eric Wong [Sun, 19 Sep 2021 12:50:21 +0000 (12:50 +0000)]
ipc: allow disabling broadcast for wq_workers

Since some lei worker classes only use a single worker,
there's no sense in having broadcast for those cases.

2 years agoipc: wq_do: support synchronous waits and responses
Eric Wong [Sun, 19 Sep 2021 12:50:20 +0000 (12:50 +0000)]
ipc: wq_do: support synchronous waits and responses

This brings the wq_* SOCK_SEQPACKET API functionality
on par with the ipc_do (pipe-based) API.

2 years agodoc: tuning: note git 2.33+, move libgit2 into Inline::C section
Eric Wong [Sun, 19 Sep 2021 00:36:04 +0000 (00:36 +0000)]
doc: tuning: note git 2.33+, move libgit2 into Inline::C section

git 2.33+ contains important optimizations for the
thousands-of-inboxes case.  And combine the Inline::C stuff
with libgit2, since our use of libgit2 requires Inline::C.

2 years agot/lei-refresh-mail-sync: improve test reliability
Eric Wong [Sat, 18 Sep 2021 22:38:43 +0000 (22:38 +0000)]
t/lei-refresh-mail-sync: improve test reliability

We can't assume -imapd will be ready by the time we try to
connect to it after restart when using "-l $ADDR".  So recreate
the (closed-for-testing) listen socket in the parent and hand it
off to -imapd as we do normally

2 years agonet_reader: quote URL properly for Tor .onion hint
Eric Wong [Sat, 18 Sep 2021 21:09:14 +0000 (21:09 +0000)]
net_reader: quote URL properly for Tor .onion hint

The semicolon in ';AUTH=ANONYMOUS' requires quoting in Bourne shell.

2 years agot/config: extra test for imap_url with imaps://
Eric Wong [Sat, 18 Sep 2021 20:33:24 +0000 (20:33 +0000)]
t/config: extra test for imap_url with imaps://

I configured this for public-inbox.org, but wasn't 100% sure it
worked.  This test ensures it stays working :>

2 years agolei up: automatically use dt: for remote externals
Eric Wong [Sat, 18 Sep 2021 09:33:32 +0000 (09:33 +0000)]
lei up: automatically use dt: for remote externals

Since we can't use maxuid for remote externals, automatically
maintaining the last time we got results and appending a dt:
range to the query will prevent HTTP(S) responses from getting
too big.

We could be using "rt:", but no stable release of public-inbox
supports it, yet, so we'll use dt:, instead.

By default, there's a two day fudge factor to account for MTA
downtime and delays; which is hopefully enough.  The fudge
factor may be changed per-invocation with the
--remote-fudge-factor=INTERVAL option

Since different externals can have different message transport
routes, "lastresult" entries are stored on a per-external basis.

2 years agonet_reader: set SO_KEEPALIVE on all Net::NNTP sockets
Eric Wong [Sat, 18 Sep 2021 09:33:31 +0000 (09:33 +0000)]
net_reader: set SO_KEEPALIVE on all Net::NNTP sockets

SO_KEEPALIVE can prevent stuck processes and is safe to enable
unconditionally on all TCP sockets (like git, and the rest of
public-inbox does).  Verified via strace on both NNTP and NNTPS
with and without nntp.proxy=socks5h://...

2 years agonet_reader: support imaps:// w/ socks5h:// proxy
Eric Wong [Sat, 18 Sep 2021 09:33:30 +0000 (09:33 +0000)]
net_reader: support imaps:// w/ socks5h:// proxy

While Non-TLS IMAP worked perfectly with IO::Socket::Socks
and Mail::IMAPClient; we need to wrap the IO::Socket::Socks
object with IO::Socket::SSL before handing it to
Mail::IMAPClient.

2 years agonet_reader: detect IMAP failures earlier
Eric Wong [Sat, 18 Sep 2021 09:33:29 +0000 (09:33 +0000)]
net_reader: detect IMAP failures earlier

An Mail::IMAPClient object may be returned even on connection
failure, so use IsConnected to check for it.  This ensures
git-credential will no longer prompt for passwords when there's
no connection.

2 years agonet_reader: tie SocksDebug to {imap,nntp}.Debug
Eric Wong [Sat, 18 Sep 2021 09:33:28 +0000 (09:33 +0000)]
net_reader: tie SocksDebug to {imap,nntp}.Debug

I think tying IO::Socket::Socks debugging to existing debug
switches is enough, and there's no need to introduce a separate
socks.Debug parameter.

2 years agods: support add unique timers
Eric Wong [Sat, 18 Sep 2021 09:33:27 +0000 (09:33 +0000)]
ds: support add unique timers

A common pattern we use is to arm a timer once and prevent
it from being armed until it fires.  We'll be using it more
to do polling for saved searches and imports.

2 years agolei_mail_sync: set nodatacow on btrfs
Eric Wong [Sat, 18 Sep 2021 09:33:26 +0000 (09:33 +0000)]
lei_mail_sync: set nodatacow on btrfs

As with other SQLite3 databases, copy-on-write with
files experiencing random writes leads to write amplification
and low performance.

2 years agolei_mail_sync: rely on flock(2), avoid IPC
Eric Wong [Sat, 18 Sep 2021 09:33:25 +0000 (09:33 +0000)]
lei_mail_sync: rely on flock(2), avoid IPC

Since 44917fdd24a8bec1 ("lei_mail_sync: do not use transactions"),
relying on lei/store to serialize access was a pointless endeavor.

Rely on flock(2) to serialize multiple writers since (in my
experience) it's the easiest way to deal with parallel writers
when using SQLite.  This allows us to simplify existing callers
while speeding up 'lei refresh-mail-sync --all=local' by 5% or
so.

2 years agolei: lock worker counts
Eric Wong [Sat, 18 Sep 2021 09:33:24 +0000 (09:33 +0000)]
lei: lock worker counts

It doesn't seem worthwhile to change worker counts dynamically
on a per-command-basis with lei, and I don't know how such an
interface would even work...

2 years agodoc: lei-lcat: document --stdin behavior
Eric Wong [Fri, 17 Sep 2021 08:44:25 +0000 (08:44 +0000)]
doc: lei-lcat: document --stdin behavior

This is another feature I've found immensely useful,
but I also wonder if I'm the only one who uses it.

2 years agogit_http_backend: forward HTTP_GIT_PROTOCOL in request headers
Eric Wong [Wed, 8 Sep 2021 16:42:29 +0000 (14:42 -0200)]
git_http_backend: forward HTTP_GIT_PROTOCOL in request headers

It looks like git-http-backend(1) will support
HTTP_GIT_PROTOCOL, soon, and we won't have to add GIT_PROTOCOL
support to support newer versions of the git protocol, either.

Link: https://public-inbox.org/git/YTiXEEEs36NCEr9S@coredump.intra.peff.net/
2 years agodoc: add lei-security(7) manpage
Eric Wong [Fri, 17 Sep 2021 12:38:36 +0000 (07:38 -0500)]
doc: add lei-security(7) manpage

It seems like a good idea to have a manpage where somebody
can quickly look up and address their concerns as to what
to put on encrypted device/filesystem.

And I probably would've designed lei around make(1) for
parallelization if I didn't have to keep credentials off
the FS :P

2 years agoscript/lei: umask(077) before execve
Eric Wong [Fri, 17 Sep 2021 12:12:30 +0000 (07:12 -0500)]
script/lei: umask(077) before execve

While my MUA also runs umask(077) unconditionally, not all
MUAs do.  Additionally, pagers may support writing its buffer
to disk, so ensure anything else we spawn has umask(077).

2 years agofetch: ignore non-writable epoch dirs
Eric Wong [Fri, 17 Sep 2021 11:00:23 +0000 (11:00 +0000)]
fetch: ignore non-writable epoch dirs

This will eventually be useful for maintaing partial mirrors.

Keeping inline with the original public-inbox-fetch philosophy,
there are no additional config files to manage:
the user merely needs to remove write permissions to an $N.git
directory to prevent it from being updated.

Re-enabling updates just requires restoring write permission.

2 years agosearch: fix rt: w/ approxidate when TZ != UTC
Eric Wong [Fri, 17 Sep 2021 04:40:07 +0000 (13:40 +0900)]
search: fix rt: w/ approxidate when TZ != UTC

While git respects a user's local timezone and returns
seconds-since-the-Epoch, we were unnecessarily and incorrectly
calling gmtime+strftime on its result.  So ignore calling
gmtime+strftime when the strftime format is "%s", just feed
the output time from git directly to Xapian.

This is mainly for lei, which will likely run in a variety of
timezones.  While we're at it, add a recommendation to use
TZ=UTC in public-inbox-httpd, in case there are (misguided :P)
sysadmins who set a non-UTC TZ.

2 years agolei refresh-mail-sync: drop old IMAP folder info
Eric Wong [Fri, 17 Sep 2021 01:56:44 +0000 (20:56 -0500)]
lei refresh-mail-sync: drop old IMAP folder info

Like with Maildir, IMAP folders can be deleted entirely.
Ensure they can be eliminated, but don't be fooled into
removing them if they're temporarily unreachable.

2 years agolei refresh-mail-sync: implicitly remove missing folders
Eric Wong [Fri, 17 Sep 2021 01:56:43 +0000 (20:56 -0500)]
lei refresh-mail-sync: implicitly remove missing folders

There's no point in keeping mail_sync.sqlite3 entries around
if the folder is gone.  We do keep saved-search configs around,
however, since somebody may decide to blow away a search and
start over.

2 years agolei refresh-mail-sync: drop unused {verify} code path
Eric Wong [Fri, 17 Sep 2021 01:56:42 +0000 (20:56 -0500)]
lei refresh-mail-sync: drop unused {verify} code path

That option was never wired up, and probably not needed...

2 years agolei refresh-mail-sync: remove "gone" notices
Eric Wong [Fri, 17 Sep 2021 01:56:41 +0000 (20:56 -0500)]
lei refresh-mail-sync: remove "gone" notices

Those stderr messages are not useful at all, and harmful with
the noise they cause.

2 years agolei_mail_sync: don't hold statement handle into callback
Eric Wong [Fri, 17 Sep 2021 01:56:40 +0000 (20:56 -0500)]
lei_mail_sync: don't hold statement handle into callback

This can cause readers and writers to conflict since the
implicit transaction from SELECT in a LeiRefreshMailSync
worker would block the LeiStore process.

2 years agolei refresh-mail-sync: replace prune-mail-sync
Eric Wong [Fri, 17 Sep 2021 01:56:39 +0000 (20:56 -0500)]
lei refresh-mail-sync: replace prune-mail-sync

Merely pruning mail synchronization information was
insufficient for Maildir: renames are common in Maildir
and we need to detect them after-the-fact when lei-daemon
isn't running.

Running this command could make "lei index" far more
useful...

v2: close R/O mail_sync.sqlite3 dbh before fork
  Keeping the DB file handle open across fork can cause bad things
  to happen even if we don't use it since sqlite3 itself still knows
  about it (but doesn't know Perl code doesn't know about it).

2 years agodoc: glossary: add a reference for "epoch"
Eric Wong [Thu, 16 Sep 2021 21:07:25 +0000 (21:07 +0000)]
doc: glossary: add a reference for "epoch"

It comes up often enough and we need to ensure it's not
confused with IMAP "slices".

2 years agolei_pmdir: do not attempt to trigger network auth
Eric Wong [Thu, 16 Sep 2021 20:15:20 +0000 (14:15 -0600)]
lei_pmdir: do not attempt to trigger network auth

Since some commands access both Maildirs and IMAP/NNTP servers
at the same time, LeiPmdir may see the same lei->{auth} and
lei->{net} objects as the sibling LeiInput-based workers.
Delete those at fork and do not attempt to do authentication in
those cases, since "net_merge_continue" will not be a registered
op and cause PktOp to fail even if authentication /can/ work
from a LeiPmdir worker.

2 years agodoc: lei-mail-formats: add "eml" and expand on git things
Eric Wong [Thu, 16 Sep 2021 07:45:45 +0000 (07:45 +0000)]
doc: lei-mail-formats: add "eml" and expand on git things

While "eml" is not an output format, it seems worthy
to document, here, since users are likely to have experience
with *.patch files from "git format-patch".

2 years agonet_reader: load IO::Socket::Socks in all workers
Eric Wong [Thu, 16 Sep 2021 09:41:16 +0000 (09:41 +0000)]
net_reader: load IO::Socket::Socks in all workers

This was previously undetected since SOCKS is mainly used for
read-only (single worker) tasks, and worker[0] always loaded
the module.  However, "lei refresh-mail-sync" can bounce reads
to any worker, so we need to ensure worker[1..Inf] load it, too.

2 years agolei: git_oid: replace git_blob_id
Eric Wong [Thu, 16 Sep 2021 09:41:14 +0000 (09:41 +0000)]
lei: git_oid: replace git_blob_id

We'll be using binary SHA-1 and SHA-256 in-memory since that's
what mail_sync.sqlite3 stores.

2 years agoimapd: sort LIST response
Eric Wong [Thu, 16 Sep 2021 02:19:43 +0000 (21:19 -0500)]
imapd: sort LIST response

While RFC 3501 doesn't require LIST responses be sorted,
it makes reading protocol dumps easier and we memoize it
once per-refresh, so it shouldn't be too expensive even
with thousands of folders.

2 years agolei ls-mail-source: sort IMAP folder names
Eric Wong [Thu, 16 Sep 2021 02:19:42 +0000 (21:19 -0500)]
lei ls-mail-source: sort IMAP folder names

Otherwise, public-inbox-imapd will emit mailboxes in random
order (as IMAP servers do not need to guarantee any sort of
ordering).  We'll take into account numeric slice numbers
generated by -imapd if they exist, so slice "80" doesn't show up
next to "8".

2 years agonet_reader: emit .onion help for potential Tor users
Eric Wong [Thu, 16 Sep 2021 02:19:41 +0000 (21:19 -0500)]
net_reader: emit .onion help for potential Tor users

We can't easily use torsocks, here, so try to be helpful
when it comes to proxy support.

2 years agowww_stream: note existence of IMAP and NNTP URLs
Eric Wong [Thu, 16 Sep 2021 00:26:53 +0000 (00:26 +0000)]
www_stream: note existence of IMAP and NNTP URLs

The "mirror" link may not clue users into the existence of
NNTP and IMAP servers, so add a note about them (but don't
list them, in case there are dozens of URLs :>).

2 years agowww: support publicinbox.imapserver
Eric Wong [Thu, 16 Sep 2021 00:26:52 +0000 (00:26 +0000)]
www: support publicinbox.imapserver

This allows PublicInbox::WWW hosts to advertise the existence of
IMAP servers in addition to NNTP servers.

2 years agoinbox: streamline ->nntp_url
Eric Wong [Thu, 16 Sep 2021 00:26:51 +0000 (00:26 +0000)]
inbox: streamline ->nntp_url

We no longer waste a precious hash slot for a per-Inbox
{nntpserver} if it's only configured globally for all inboxes.

2 years agosupport -C (chdir) for most non-daemon commands
Eric Wong [Wed, 15 Sep 2021 21:35:59 +0000 (21:35 +0000)]
support -C (chdir) for most non-daemon commands

Because make(1), git(1), tar(1) all support -C in this form, as
do our newer commands such as lei, public-inbox-{clone,fetch}.

2 years agofetch|clone|--mirror: shorten paths for progress output
Eric Wong [Wed, 15 Sep 2021 21:35:58 +0000 (21:35 +0000)]
fetch|clone|--mirror: shorten paths for progress output

The full pathname for "curl -o ..." was too noisy and confusing.
Reduce confusion by adding the ".tmp" suffix and relying on
"-C".  We'll also avoid displaying "-C" in run_reap() and
rely on "--git-dir=" with "git fetch" to display progress for
users.

2 years agoclone|fetch|--mirror: add convenience $INBOX_DIR/Makefile
Eric Wong [Wed, 15 Sep 2021 21:35:57 +0000 (21:35 +0000)]
clone|fetch|--mirror: add convenience $INBOX_DIR/Makefile

Since the beginning of time, I've been dropping Makefiles
in $INBOX_DIR (and above hiearchies) to organize groups
of commands.

make(1) is widely available in various flavors and a familiar
tool for our target audience.  It is easy to run in the right
directory, typically has built-in shell completion, and doesn't
silently ignore errors by default like Bourne shell.

2 years agoTODO: update some items
Eric Wong [Wed, 15 Sep 2021 21:35:56 +0000 (21:35 +0000)]
TODO: update some items

Some things (extindex) done, many more to do; and -fetch should
set us up for v1 => v2 migrations at some point...

2 years agofetch: support --exit-code switch
Eric Wong [Wed, 15 Sep 2021 21:35:55 +0000 (21:35 +0000)]
fetch: support --exit-code switch

As noted in the new manpage entry, this is useful for avoiding
public-inbox-index invocations when there's nothing to update.
We use 127 to match "grok-pull", and also because it doesn't
conflict with any of the current curl(1) exit codes.

2 years agolei_saved_search: fix prefix for IMAP folders w/ slash
Eric Wong [Wed, 15 Sep 2021 17:43:41 +0000 (17:43 +0000)]
lei_saved_search: fix prefix for IMAP folders w/ slash

We failed to account for IMAP mailboxes containing `/'
characters when creating saved search files for them.

Reported-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://public-inbox.org/meta/20210915123347.knr4qpaei73tjc5q@meerkat.local/
2 years agomulti_git: hoist out common epoch/alternates handling
Eric Wong [Wed, 15 Sep 2021 11:26:17 +0000 (11:26 +0000)]
multi_git: hoist out common epoch/alternates handling

IMHO, this greatly improves code sharing and organization
between v2, extindex, and lei/store.  Common git-related
logic for these is lightly-refactored and easier to reason
about.

The impetus for this big change was to ensure inboxes
created+managed by public-inbox-{clone,fetch} could have
alternates and configs setup properly without depending on
SQLite (via V2Writable).  This change does that while
making old code shorter and better factored.

2 years agouri_imap: fix ->uidvalidity and ->uid w/ `/' separator
Eric Wong [Tue, 14 Sep 2021 22:10:36 +0000 (22:10 +0000)]
uri_imap: fix ->uidvalidity and ->uid w/ `/' separator

Again, we were failing to account for '/' use in mailbox names :x

Reported-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://public-inbox.org/meta/20210914210547.akdp4cqmwaheayp5@meerkat.local/