Eric Wong [Sat, 21 Mar 2020 02:03:52 +0000 (02:03 +0000)]
wwwtext: show thread endpoint w/ indexlevel=basic
And show contact info when there's no indexing, at all.
Installations where Xapian is too expensive can still support
threading since it only depends on SQLite, so we need to inform
users of what's available.
Eric Wong [Sat, 21 Mar 2020 02:03:51 +0000 (02:03 +0000)]
search: clobber -user_pfx on query parser initialization
While we don't currently reinitialize the query parser for
the lifetime of a PublicInbox::Search object and have no plans
to, it's incorrect to be appending to an existing array in
case we reininitialize the query parser in the future.
Eric Wong [Sat, 21 Mar 2020 02:03:50 +0000 (02:03 +0000)]
qspawn: handle ENOENT (and other errors on exec)
As sqlite3(1) and other executables may become unavailable or
uninstalled while a daemon runs, we need to gracefully handle
errors in those cases.
Eric Wong [Sat, 21 Mar 2020 02:03:49 +0000 (02:03 +0000)]
mbox: need_gzip uses WwwStream::oneshot
This makes the error page more consistent.
Not that it really matters since Compress::Raw::Zlib and
IO::Compress packages have been distributed with Perl since
5.10.x. Of course, zlib itself is also a dependency of git.
Eric Wong [Sat, 21 Mar 2020 02:03:48 +0000 (02:03 +0000)]
wwwstream: oneshot sets content-length
PublicInbox::HTTP will chunk, otherwise, and that's
extra overhead which isn't needed.
Eric Wong [Sat, 21 Mar 2020 02:03:47 +0000 (02:03 +0000)]
extmsg: use WwwResponse::oneshot
No reason to use the ->getline interface for small responses.
Eric Wong [Sat, 21 Mar 2020 02:03:46 +0000 (02:03 +0000)]
wwwstream: introduce oneshot API to avoid ->getline
The ->getline API is only useful for limiting memory use when
streaming responses containing multiple emails or log messages.
However it's unnecessary complexity and overhead for callers
(PublicInbox::HTTP) when there's only a single message.
Eric Wong [Sat, 21 Mar 2020 02:03:45 +0000 (02:03 +0000)]
gzipfilter: lazy allocate the deflate context
zlib contexts are memory-intensive, particularly when used for
compression. Since the gzip filter may be sitting in a limiter
queue for a long period, delay the allocation we actually have
data to translate, and not a moment sooner.
Eric Wong [Sat, 21 Mar 2020 02:03:44 +0000 (02:03 +0000)]
qspawn: reinstate filter support, add gzip filter
We'll be supporting gzipped from sqlite3(1) dumps
for altid files in future commits.
In the future (and if we survive), we may replace
Plack::Middleware::Deflater with our own GzipFilter to work
better with asynchronous responses without relying on
memory-intensive anonymous subs.
Eric Wong [Sun, 22 Mar 2020 08:58:49 +0000 (08:58 +0000)]
daemon: unlink .oldbin PID file correctly
We need to track the PID file having ".oldbin" appended
to it while a SIGUSR2 upgrade is in progress and ensure
it is unlinked on SIGQUIT.
Eric Wong [Sun, 22 Mar 2020 08:58:48 +0000 (08:58 +0000)]
daemon: fix SIGUSR2 upgrade with -W0 (no workers)
Disabling workers via `-W0' blesses the contents of the
@listeners array, so we need to ensure we call fcntl on
the GLOB ref in ->{sock}.
Add tests to ensure USR2 works regardless of whether workers
are enabled or not.
Eric Wong [Fri, 20 Mar 2020 08:18:21 +0000 (08:18 +0000)]
v2: SDBM-based multi Message-ID queue
This lets us store author and committer times for deferred
indexing messages with ambiguous Message-IDs. This allows
us to reproducibly reindex messages with the git commit
and author times when a rare message lacks Received and/or
Date headers while having ambiguous Message-IDs.
Eric Wong [Fri, 20 Mar 2020 08:18:20 +0000 (08:18 +0000)]
*idx: pass smsg in even more places
We can finally get rid of the awkward, ad-hoc use of V2Writable,
SearchIdx, and OverIdx args for passing {cotime} and {autime}
between classes.
We'll still use those git time fields internally within
V2Writable and SearchIdx for (re)indexing, but that's not
worth avoiding as a fallback.
Eric Wong [Fri, 20 Mar 2020 08:18:19 +0000 (08:18 +0000)]
v2: pass smsg in more places
We can pass fewer order-dependent args to V2Writable::do_idx and
SearchIdxShard::index_raw by passing the smsg object, instead.
Eric Wong [Fri, 20 Mar 2020 08:18:18 +0000 (08:18 +0000)]
*idx: pass $smsg in more places instead of many args
We can pass blessed PublicInbox::Smsg objects to internal
indexing APIs instead of having long parameter lists in some
places. The end goal is to avoid parsing redundant information
each step of the way and hopefully make things more
understandable.
Eric Wong [Fri, 20 Mar 2020 08:18:17 +0000 (08:18 +0000)]
overidx: parse_references: less error-prone args
Favor `$smsg->{mid}' instead of `$mid0' to reduce parameters
down-the-line, but favor passing the Email::MIME::Header object
around instead of relying on the bloat-prone `$smsg->{mime}'
and calling ->header_obj on it.
Eric Wong [Fri, 20 Mar 2020 08:18:16 +0000 (08:18 +0000)]
smsg: to_doc_data: use existing fields
No need to pass extra parameters to this method, since
smsg has universal meanings for {blob} and {mid}.
Eric Wong [Fri, 20 Mar 2020 08:18:15 +0000 (08:18 +0000)]
rename PublicInbox::SearchMsg => PublicInbox::Smsg
Since the introduction of over.sqlite3, SearchMsg is not tied to
our search functionality in any way, so stop confusing ourselves
and future hackers by just calling it "PublicInbox::Smsg".
Add a missing "use" in ExtMsg while we're at it.
Eric Wong [Fri, 20 Mar 2020 08:18:14 +0000 (08:18 +0000)]
v2writable: preserve timestamps from import
While v2 indexing is triggered immediately after writing the
commit to the git repository, there may be a gap between when
PublicInbox::Import generates a timestamp and when
PublicInbox::SearchIdx sees the message. So follow the mirror
indexing behavior and take the to-be-indexed (time|date)stamps
directly from the git commit.
Eric Wong [Fri, 20 Mar 2020 08:18:13 +0000 (08:18 +0000)]
index: use git commit times on missing Date/Received
When indexing messages without Date: and/or Received: headers,
fall back to using timestamps originally recorded by git in the
commit object. This allows git mirrors to preserve the import
datestamp and timestamp of a message according to what was fed
into git, instead of blindly falling back to the current time.
Eric Wong [Sat, 21 Mar 2020 06:18:27 +0000 (01:18 -0500)]
t/msgtime: skip test if timezone isn't UTC
Date::Parse falls back to using the local timezone when
it's missing from an email, so only test in a reasonable
TZ (UTC) for server software.
Eric Wong [Sat, 21 Mar 2020 05:24:32 +0000 (05:24 +0000)]
t/www_listing: avoid 'once' warnings
We reach into the WwwListing package directly to retrieve
that JSON encoder/decoder object, and we can't rely on `use'
since WwwListing loading may fail if Plack is missing.
Eric Wong [Sat, 21 Mar 2020 01:10:33 +0000 (01:10 +0000)]
wwwlisting: use first successfully loaded JSON module
And not the last...
I only noticed this since JSON::PP::Boolean was spewing
redefinition warnings via overload.pm
Fixes: 8fb8fc52420ef669 ("wwwlisting: avoid lazy loading JSON module")
Eric Wong [Thu, 19 Mar 2020 23:55:50 +0000 (23:55 +0000)]
examples/*.psgi: add examples for -httpd
public-inbox-httpd should work with any PSGI files, so make
it more apparent to people reading .psgi examples.
Eric Wong [Thu, 19 Mar 2020 08:32:56 +0000 (03:32 -0500)]
viewdiff: favor `qr' to precompile regexps
We can also avoid `o' regexp modifier, since it isn't
recommended by Perl upstream, anymore (although we don't
have any bugs or unintended behavior because of it).
Eric Wong [Thu, 19 Mar 2020 08:32:55 +0000 (03:32 -0500)]
daemon: do more immortal allocations up front
Doing immortal allocations late can cause those allocations
to end up in places where it fragments the heap. So do more
things up front for long-lived daemons.
Eric Wong [Thu, 19 Mar 2020 08:32:54 +0000 (03:32 -0500)]
www: avoid `state' usage to perform allocations up-front
We want WWW->preload to get as many immortal allocations done
as possible, and the `state' feature from Perl 5.10 prevents that.
Eric Wong [Thu, 19 Mar 2020 08:32:53 +0000 (03:32 -0500)]
wwwlisting: avoid lazy loading JSON module
We already lazy-load WwwListing for the CGI script, and
hiding another layer of lazy-loading makes things difficult
to do WWW->preload.
We want long-lived processes to do all long-lived allocations up
front to avoid fragmentation in the allocator, but we'll still
support short-lived processes by lazy-loading individual modules
in the PublicInbox::* namespace.
Mixing up allocation lifetimes (e.g. doing immortal allocations
while a large amount of space is taken by short-lived objects)
will cause fragmentation in any allocator which favors large
contiguous regions for performance reasons. This includes any
malloc implementation which relies on sbrk() for the primary
heap, including glibc malloc.
Eric Wong [Thu, 19 Mar 2020 08:32:52 +0000 (03:32 -0500)]
wwwlisting: favor "use" over require
"use" is also evaluated earlier than "require", so it is
favorable for compile-only checking.
Eric Wong [Thu, 19 Mar 2020 08:32:51 +0000 (03:32 -0500)]
www: update ->preload for newer modules
We'll also avoid explicitly loading standard library modules
like POSIX and Digest::SHA, here; instead we load our own
modules and let those load whatever non-PublicInbox:: modules
they need.
Eric Wong [Thu, 19 Mar 2020 07:51:53 +0000 (07:51 +0000)]
doc: standards: add references to RFC 5322 (and RFC 822)
RFC 5322 is the latest one in this line, but much documentation
and even command-line options in other programs (e.g. git) refer
to RFC 2822 or even RFC 822.
Eric Wong [Tue, 17 Mar 2020 06:52:17 +0000 (06:52 +0000)]
http: fix RFC conformance w.r.t. message length
We need to favor "Transfer-Encoding: chunked" over the value of
the Content-Length header. We should also reject bogus,
duplicate and/or unreasonable values for both these, since they
can trigger unexpected behavior when combined with other HTTP
parsers in proxies such as varnish, nginx, haproxy, etc...
See RFC 7230 (and RFC 2616) for more details:
https://tools.ietf.org/html/rfc7230
https://www.rfc-editor.org/errata_search.php?rfc=7230
Eric Wong [Tue, 3 Mar 2020 05:03:11 +0000 (05:03 +0000)]
INSTALL: refer to the proper Debian version
Debian 10.0 was released July 2019, so update our documentation
to reflect that. While we're at it, fixup a broken footnote
reference for Inline::C, too.
Eric Wong [Sat, 7 Mar 2020 12:15:23 +0000 (12:15 +0000)]
daemon: remove unused $parent_pipe variable
We can just create a ParentPipe and let PublicInbox::DS
manage its life cycle. While we're at it, favor `\&coderef'
over `*coderef' so we're explicit about it being a code ref
and not some other ref type.
Eric Wong [Sat, 7 Mar 2020 10:57:02 +0000 (10:57 +0000)]
searchmsg: allow lines (and bytes) to be zero
We will occasionally see legit messages with zero lines,
be sure we index that count for NNTP clients.
I'm not sure about bytes being zero (aside from purged
messages), but we should've dealt with that earlier up
the stack.
Eric Wong [Tue, 3 Mar 2020 10:11:20 +0000 (10:11 +0000)]
git: remove POSIX::dup2 import
We rely on spawn/popen_rd for redirects, nowadays.
Eric Wong [Tue, 3 Mar 2020 09:50:57 +0000 (09:50 +0000)]
spawn: correctly handle error code
Both the C and pure Perl implementions of `pi_fork_exec'
returns `-1' on error, not `undef'.
Eric Wong [Tue, 25 Feb 2020 09:23:03 +0000 (09:23 +0000)]
msgtime: assume +0000 if TZ missing when using Date::Parse
Some old emails don't have timezone offsets, since our
Date::Parse code path takes a liberal interpretation of dates,
fallback to using "+0000" as the timezone offset since it's
closer to the actual date of the message than whatever the
current date is.
Reported-by: Leah Neukirchen <leah@vuxu.org>
Link: https://public-inbox.org/meta/87h7zfemur.fsf@vuxu.org/
Fixes: ae80a3fdb53d7014 ("MsgTime.pm: Use strptime to compute the time zone")
Eric Wong [Wed, 26 Feb 2020 10:21:12 +0000 (10:21 +0000)]
import: drop '<' and '>' characters in addresses
Some strange "From:" lines will cause Email::Address::XS to
leave '<' (and presumably '>') in the address which
git-fast-import won't accept even if quoted. Workaround this
problem by deleting '<' and '>' the same way we delete them for
the ident name.
Reported-by: Leah Neukirchen <leah@vuxu.org>
Link: https://public-inbox.org/meta/87h7zfemur.fsf@vuxu.org/
Eric Wong [Thu, 27 Feb 2020 22:11:50 +0000 (16:11 -0600)]
INSTALL: update for 1.3.0+, clarify IO::Compress
IO::Compress is required for v2 inboxes and overview
indices, after all, but it is often pulled in by
other packages (HTTP::Message via Plack::Test).
Eric Wong [Thu, 27 Feb 2020 13:34:51 +0000 (13:34 +0000)]
doc: design_www: document offline friendliness
This isn't anything new and has been a part of the design
since the beginning, but it may not be apparent to some
folks.
Eric Wong [Wed, 26 Feb 2020 00:44:05 +0000 (00:44 +0000)]
searchview: improve naming and simplify hash override
`%over' could be confused for the overview SQLite DB
instance, so call it `%override', instead. There's
also no need to write a loop to override a hash when
the language can do it for us.
Eric Wong [Tue, 25 Feb 2020 22:57:38 +0000 (16:57 -0600)]
doc: 1.4.0 release notes update
Perhaps 1.4.0 will be a small release, after all (and also
smaller in terms of memory use :)
Eric Wong [Mon, 24 Feb 2020 08:08:22 +0000 (08:08 +0000)]
v2writable: lookup_content => content_exists
It only needs to return a boolean, since none of the current
callers care about the return value. Thus avoid a hash table
assignment and use of `$smsg->{mime}', here.
Eric Wong [Mon, 24 Feb 2020 08:08:21 +0000 (08:08 +0000)]
v2writable: make remove return-compatible w/ Import::remove
Import::remove is a documented interface, and the return
value of the V2Writable work-alike should try to be compatible
with what Import implements.
Eric Wong [Mon, 24 Feb 2020 07:33:28 +0000 (07:33 +0000)]
examples/nginx_proxy: convert CRLF to LF
It was the only file in our tree which had CRLF line endings,
so make it consistent with the rest.
Eric Wong [Mon, 24 Feb 2020 07:33:27 +0000 (07:33 +0000)]
viewdiff: remove optional CR handling
The only caller of `flush_diff' is `add_text_body', and that
already did CRLF conversion on the text part. The regexps in
SolverGit still need to preserve CR, however, since that
actually applies patches (instead of rendering them), and we
need to preserve CRLF patches for CRLF files.
Eric Wong [Mon, 24 Feb 2020 07:33:26 +0000 (07:33 +0000)]
hval: ascii_html: drop CRLF => LF conversion
Instead, we add CRLF conversion to the only remaining place
which needs it, ViewVCS. This save many redundant ops in in
many places.
The only other place where this mattered was in
View::add_text_body, but we already started doing CRLF
conversions when we added diff parsing and link generation for
ViewVCS. Otherwise, all other places we used this was for
header viewing and Email::MIME doesn't preserve CRLF in headers.
Eric Wong [Mon, 24 Feb 2020 00:17:24 +0000 (18:17 -0600)]
import_vger_from_mbox: add --filter parameter
It shouldn't be hard to make this into a more generic
importer not specific to vger lists.
Eric Wong [Mon, 24 Feb 2020 00:17:23 +0000 (18:17 -0600)]
import_vger_from_mbox: drop redundant "use" statements
PublicInbox::InboxWritable takes care of those imports.
Eric Wong [Sun, 23 Feb 2020 22:47:15 +0000 (22:47 +0000)]
searchview: set obfuscation inbox properly
We never lookup `$ctx->{-obfuscate}' anywhere, as the
correct key is `$ctx->{-obfs_ibx}' since some of the
address obfuscation stuff is inbox-specific.
Note: some of the obfuscation stuff still needs tests,
but it's low-priority at the moment since I don't think
it's a good feature after all.
Eric Wong [Sun, 23 Feb 2020 12:27:30 +0000 (12:27 +0000)]
doc: technical: document data structures
Can't code without data structures, and we emphasize
data over code just about everywhere.
Eric Wong [Sun, 23 Feb 2020 22:43:37 +0000 (22:43 +0000)]
INSTALL: s/repositories/inboxes/
Since v2 inboxes can be made of several git repositories,
consistently call them "inboxes", instead.
Eric Wong [Sat, 22 Feb 2020 08:27:29 +0000 (08:27 +0000)]
doc: improve wording of "inbox" vs "repository"
Since v2 inboxes contain multiple git repositories, avoid the
use of the word "repository" when referring to inboxes as a
whole in most places.
Eric Wong [Mon, 17 Feb 2020 11:00:48 +0000 (05:00 -0600)]
view: shorten life of MIME object for permalink
We don't need to hold onto the Email::MIME object across
multiple WwwResponse->getline calls, instead we can stuff
the rendered HTML of the first (and hopefully only) message
of the buffer into ctx->{-html_tip}.
Eric Wong [Sun, 16 Feb 2020 10:24:35 +0000 (10:24 +0000)]
doc: design_www: document solver endpoint
The blob regeneration (solving) part has been stable and
performant for over a year with no problems, even with web
crawlers constantly hitting it without needing rate limits.
All the other stuff is open to bikeshedding (as long as
my crappy hardware supports it :P)
Eric Wong [Sun, 16 Feb 2020 10:07:30 +0000 (04:07 -0600)]
viewdiff: do not generate "a=" parameter if "b=" matches
Long URLs waste bandwidth and redundant query parameters
make caching more difficult and expensive.
Fixes: ddec19694cbf0e1d ("viewdiff: rewrite and simplify")
Eric Wong [Sat, 15 Feb 2020 09:46:40 +0000 (09:46 +0000)]
view: remove last Hval->new caller
The object-oriented Hval API turned out to be less useful and
more clunky than I envisioned years ago, so get rid of it.
We'll no longer strip trailing whitespace from From: headers in
the HTML display, but I doubt anybody cares.
Eric Wong [Sat, 15 Feb 2020 09:46:39 +0000 (09:46 +0000)]
view: escape ampersand in Message-IDs
We need to escape ampersands (and some other characters for href
attributes), so introduce a `mid_href' sub to do just that.
'<', '>' and '"' were always escaped, so there's no risk of tag
or attribute injection, but creative Message-IDs could cause
confusion for some parsers and generate invalid URLs.
Start getting rid of the bloated, over-engineered OO Hval API
while we're at it, I only noticed this bug because I started
killing off Hval->new* callers.
Eric Wong [Sat, 15 Feb 2020 09:46:38 +0000 (09:46 +0000)]
view: escape Subject HTML directly
No need to use the over-engineered Hval OO API when the subject
is already normalized and there's no trailing spaces because of
normalization.
Eric Wong [Sat, 15 Feb 2020 09:46:37 +0000 (09:46 +0000)]
view,searchview: avoid smsg method calls when using SQLite/Xapian
We already pre-populate the hashref when loading $smsg
(PublicInbox::SearchMsg) objects out of over.sqlite3 or Xapian,
so making expensive method calls isn't necessary in those cases.
We only need to use the method calls when SQLite or Xapian are
not available or are being populated (such as during indexing).
Eric Wong [Sat, 15 Feb 2020 09:46:36 +0000 (09:46 +0000)]
view: cleanup topic accumulation and dumping
Avoid needlessly normalizing the subject when dumping, since
it's pushed into the @$topic array during accumulation in
normalized form.
We can also safely treat $smsg as a hashref and avoid
calling "->ds" as a method since we know we've got that
loaded via Over||Search and won't have to use Email::MIME
header lookup methods.
Eric Wong [Sat, 15 Feb 2020 09:46:35 +0000 (09:46 +0000)]
view: dump_topics: better naming of top Subject
We use `$top' in other places, so name it to `$top_subj'
consistently for `$subj' and `$prev_subj' comparisons down
the function.
Eric Wong [Sat, 15 Feb 2020 09:46:34 +0000 (09:46 +0000)]
view: single id="t" for multi-Subject messages
While multi-Subject messages are unfortunate, try not to
generate confusing/invalid HTML with multiple elements
having the same HTML id attribute.
Eric Wong [Sat, 15 Feb 2020 09:46:33 +0000 (09:46 +0000)]
view: remove mhref arg from multipart_text_as_html
No point in passing something on stack only to stash it
into the $ctx which holds most other parameters used for
rendering the HTML.
Eric Wong [Fri, 14 Feb 2020 07:05:22 +0000 (07:05 +0000)]
t/msg_iter: test for X-UNKNOWN charset from Alpine
A long overdue test for behavior established in 2016.
Fixes: 1b28cc7f00a866cb ("view: try assuming UTF-8 for bogus charsets")
Eric Wong [Mon, 10 Feb 2020 05:55:21 +0000 (23:55 -0600)]
doc: update v1.3.0.eml with actual headers, start v1.4.0
Bigger changes coming :>
Eric Wong [Mon, 10 Feb 2020 05:40:27 +0000 (05:40 +0000)]
public-inbox 1.3.0
Eric Wong [Sat, 8 Feb 2020 18:30:40 +0000 (18:30 +0000)]
t/multi-mid: skip properly w/o DBD::SQLite
SearchIdx always requires DBD::SQLite, so only require it
after we've passed `require_mods(qw(DBD::SQLite))'.
Eric Wong [Sat, 8 Feb 2020 18:08:49 +0000 (18:08 +0000)]
convert: preserve indexlevel on conversions
We don't want to blow up users storage too badly when converting
v1 to v2 or break because they don't have Xapian bindings installed.
Eric Wong [Fri, 7 Feb 2020 08:31:58 +0000 (02:31 -0600)]
doc: more 1.3.0 release notes updates
Eric Wong [Fri, 7 Feb 2020 08:31:57 +0000 (02:31 -0600)]
doc: mark some TODO items as done
NNTP TLS and COMPRESS support and cgit spawning from
the WWW interface were implemented last year.
Given the lack of syscall number stability guarantee on the
OpenBSD and FreeBSD, I don't think supporting a pure-Perl kevent
is feasible. Inline::C may still be an option since IO::KQueue
is abandoned, though, as it is for some Linux-only syscalls and
maybe some POSIX ones not covered by POSIX.pm.
Eric Wong [Fri, 7 Feb 2020 08:31:56 +0000 (02:31 -0600)]
doc: update copyright for standards.perl
It was missing "(C)", so gnulib update-copyright missed it.
Eric Wong [Thu, 6 Feb 2020 20:59:45 +0000 (20:59 +0000)]
tests: switch to XML::TreePP for testing Atom feeds
XML::Feed pulls in a lot of dependencies, some of which XS.
That makes testing with blead or any non-OS-supplied Perl
installations more time consuming and more difficult because
of the need to have development headers and libraries for
libexpat1 or libxml2.
Performance from libexpat1 or libxml2 for our small tests cases
isn't relevant, either, and the pure Perl XML::TreePP seems up
to the task. It's also available in CentOS 7.x, FreeBSD 11.x,
and Debian, at least.
Eric Wong [Thu, 6 Feb 2020 08:49:36 +0000 (08:49 +0000)]
syscall: support Linux x32 ABI
The x32 ABI allows users to take advantage of the extra
registers on x86-64 without the bloat of 64-bit pointers and
longs.
This ought to be significant since Perl was designed when 32-bit
was prevalent; and the common structs for ops, hashes, scalars,
and arrays use longs (SSize_t/Size_t) for things which should
never need 64-bits when processing emails.
Debian's x32 port seems to work quite nicely under a chroot
on an amd64 Linux system. All tests pass under x32, now.
Eric Wong [Thu, 6 Feb 2020 19:14:48 +0000 (13:14 -0600)]
treewide: run update-copyrights from gnulib for 2019
I didn't wait until September to do it, this year!
Eric Wong [Thu, 6 Feb 2020 19:11:49 +0000 (19:11 +0000)]
MANIFEST: add flow.{ge,txt}
Oops :x
Eric Wong [Thu, 6 Feb 2020 04:03:49 +0000 (22:03 -0600)]
doc: v1: add a reference to git-filter-repo(1), too
The git-filter-branch(1) manpage itself recommends git-filter-repo,
nowadays due to performance and safety problems.
Eric Wong [Thu, 6 Feb 2020 04:03:48 +0000 (22:03 -0600)]
doc: txt2pre: auto-linkify manpage references
This can be more convenient for people browsing HTML docs
remotely or locally.
Eric Wong [Thu, 6 Feb 2020 04:03:47 +0000 (22:03 -0600)]
doc: remove .x/ subdirectory for Xapian manpages
There's no need to keep Xapian manpage renderings in a separate
subdirectory, after all.
Eliminating this difference between the local FS and URL path
will allow relative URLs to the Xapian manpages in our local
HTML documentation to work smoothly, since there was never any
".x/" path component for files served from public-inbox.org
Eric Wong [Thu, 6 Feb 2020 04:03:46 +0000 (22:03 -0600)]
doc: add data flow diagram using Graph::Easy
Maybe this can make it easier for new and potential
users to understand what's going on.
Eric Wong [Thu, 6 Feb 2020 09:18:37 +0000 (09:18 +0000)]
t/multi-mid: don't access ~/.public-inbox/config
It can cause unpredictable behavior and also slow things down.
Followup-to: e4d3be19612b2082 ("t: localize the PI_CONFIG env")
Eric Wong [Tue, 4 Feb 2020 21:44:04 +0000 (21:44 +0000)]
doc: recommend -compact after --reindex
It's likely a user will be low on space after running --reindex,
so recommend the use of public-inbox-compact afterwards.
And add a few more notes about using public-inbox-compact to
clarify it's for inboxes-only (and not any old Xapian DBs) that
using xapian-compact(1) directly is error-prone and likely to
break things.
Eric Wong [Tue, 4 Feb 2020 04:44:25 +0000 (04:44 +0000)]
over: simplify read-only vs read-write checking
No need to call ref() and do a string comparison. Add some
extra tests using the {ReadOnly} attribute in DBI.pm.
Eric Wong [Tue, 4 Feb 2020 04:44:24 +0000 (04:44 +0000)]
inbox: remove TODO item for msg_by_path
It's an old function which only gets called by inboxes w/o
SQLite indices.
Eric Wong [Tue, 4 Feb 2020 04:44:23 +0000 (04:44 +0000)]
inbox: simplify ->description and ->cloneurl
We can use "//=" from Perl 5.10 to simplify the logic for these
methods. The use of chomp() in ->cloneurl was also unnecessary
since split(/\s+/s,...) already removes newlines.
Eric Wong [Tue, 4 Feb 2020 04:44:22 +0000 (04:44 +0000)]
www: serve $INBOX_DIR/description as $INBOX_URL/description
Instead of serving $INBOX_DIR/all.git/description, since
$INBOX_DIR/all.git/description is not described in the
default message when it's missing.
Eric Wong [Tue, 4 Feb 2020 04:44:21 +0000 (04:44 +0000)]
www: stricter regexp for 405 errors
We want to match "GET" and "HEAD" exactly, not requests which
start with "GET" or end with "HEAD". This doesn't seem like
a real problem for public-inboxes which are actually public
data anyways.
Eric Wong [Tue, 4 Feb 2020 11:15:15 +0000 (11:15 +0000)]
doc: spellling fixes for manpages
The wording for publicinbox.nntpserver was awkward, too, and I
took this as opportunity to hopefully clarify it and favor
"hostname" for Internet addresses, because we already use
"address" to mean "email address" in the config.
Eric Wong [Sun, 2 Feb 2020 17:51:26 +0000 (17:51 +0000)]
spawn: actually die on (vfork|fork) failures
Commit
9f5a583694396f84 ("spawn (and thus popen_rd) die on failure")
was incomplete in that it only removed error checking for spawn
failures for non-(vfork|fork) calls, but the actual (vfork|fork)
PID result could still be undef.
Fixes: 9f5a583694396f84 ("spawn (and thus popen_rd) die on failure")
Eric Wong [Sun, 2 Feb 2020 06:52:22 +0000 (06:52 +0000)]
v2writable: more ways to detect online CPU count
OpenBSD and FreeBSD support `getconf NPROCESSORS_ONLN` (no
leading underscore). They may also have GNU nproc installed as
"gnproc".
We may also encounter Linux systems w/o GNU coreutils, but able
to use `getconf _NPROCESSORS_ONLN` (with leading underscore).
Eric Wong [Sun, 2 Feb 2020 06:52:21 +0000 (06:52 +0000)]
doc: -convert: document switches
These switches have always been there, but were not
documented until now.
Eric Wong [Sun, 2 Feb 2020 06:52:20 +0000 (06:52 +0000)]
convert: fix --no-index switch
The (currently undocumented) "--no-index" flag did not trigger
the V2Writable->done call necessary to make the import
successful.
Fixes: eea47b676127bcdb ("convert: preserve highwater mark from v1 msgmap")
Eric Wong [Sun, 2 Feb 2020 06:52:19 +0000 (06:52 +0000)]
convert: shift @ARGV explicitly
Relying on implicit "@_" for shift fails with
TestCommon::_run_sub iff GetOptions modifies @ARGV.
Eric Wong [Sun, 2 Feb 2020 06:52:18 +0000 (06:52 +0000)]
searchidxshard: rely on autoflush instead of ->flush
It reduces the number of ops and simplifies the code, slightly.
Add a missing IO::Handle import while we're at it, to be
explicit about which methods we use.
Eric Wong [Sun, 2 Feb 2020 06:52:17 +0000 (06:52 +0000)]
convert: remove unused variables capturing :from
Looking at git history, they were never used.
Eric Wong [Sun, 2 Feb 2020 06:52:16 +0000 (06:52 +0000)]
v2writable: do not clobber {shards} or {parallel} if unset
The $jobs parameter in `public-inbox-convert' is passed to
V2Writable->init_inbox as `undef' by default, causing
parallelization to be disabled.
Instead, leave the underlying {parallel} flag untouched if
$shards is undef and do not clobber the default shard count.
This allows us to take advantage of multicore systems when
running public-inbox-convert with no command-line switches.
Eric Wong [Sun, 2 Feb 2020 06:52:15 +0000 (06:52 +0000)]
v2writable: nproc_shards: subtract 1 from given value
This is to be consistent with the `nproc(1)' code path. It also
quiets down a warning from Admin when "-j $JOBS" is specified,
since the master process (which distributes work to shards and
handles OverIdx and Msgmap) is considered a job on its own.
Eric Wong [Sun, 2 Feb 2020 06:52:14 +0000 (06:52 +0000)]
t/multi-mid.t: extra test for -convert highwater mark
This is derived from a real-world test case where I encounterd
multiple Message-IDs in a v1 inbox causing regen problems.
Fixes: eea47b676127bcdb ("convert: preserve highwater mark from v1 msgmap")
Eric Wong [Fri, 31 Jan 2020 23:45:18 +0000 (23:45 +0000)]
doc: more 1.3.0 release notes updates
Some updates with recent bugfixes and a few wording/formatting
improvements.