cli/search: replace deprecated notmuch_message_get_flag

Our handling of errors is all or nothing here, but it's an improvement
on the status quo, and it avoids rippling internal API changes.

lib: catch exceptions in n_m_get_flag, provide n_m_get_flag_st

It's not very nice to return FALSE for an error, so provide
notmuch_message_get_flag_st as a migration path.

Bump LIBNOTMUCH_MINOR_VERSION because the API is extended.

configure: make sure WITH_PYTHON_DOCS is initialized

Thanks to pazz for reporting the problem.

doc: add new python bindings to main documentation tree.

A separate conf.py and doc directory (or will be needed if someone wants
to build the bindings docs separately from notmuch.

doc: replace use of environment variables with a generated config

It is getting unwieldy to pass configuration options on the
sphinx-build command line, and I anticipate further use of
conditionals.

As far as I could tell, execing a string is the idiomatic way to
emulate include in Python.

lib: use COERCE_STATUS in n_m_{add,remove}_tag

Currently I don't know of a good way of testing this, but at least in
principle a Xapian exception in _notmuch_message_{add,remove}_term
would cause an abort in the library.

lib: catch Xapian exceptions in n_m_remove_tag

The churn here is again mainly re-indentation.

test: add broken test for n_m_remove_tag

Exception will be caught in next commit.

lib: catch Xapian exceptions in n_m_add_tag

This is mostly just (horizontal) code movement due to wrapping
everything in a try / catch.

test: add known broken test for n_m_add_tag with closed db

Exception will be caught in next commit.

lib: catch Xapian exceptions in n_m_count_files

This will require some care for the caller to check the sign, and not
just add error returns into a running total.

test: add known broken test for n_m_count_files

This will be fixed in the next commit.

lib: catch Xapian exceptions in n_m_get_tags

This allows the function to return an error value rather than
crashing.

test: add known broken test for n_m_get_tags

This will be fixed in the next commit.

lib: use LOG_XAPIAN_EXCEPTION in n_m_get_date

This should not change functionality, but does slightly reduce code
duplication. Perhaps more importantly it allows consistent changes to
all of the similar exception handling in message.cc.

lib: add regression test for n_m_get_date; clarify API

This function catches Xapian exceptions. The test is intended to make
sure it stays that way.

test: add known broken for n_m_get_flag on closed db

Exception caught in next commit. Note that FLAG_GHOST is the only one
that triggers the I/O code path.

lib: catch exceptions in n_m_get_filenames

This is essentially copied from the change to notmuch_message_get_filename

test: add known broken test for n_m_get_filenames

This will be fixed in the next commit

lib/n_m_g_filename: catch Xapian exceptions, document NULL return

This is the same machinery as applied for

     notmuch_message_get_{thread,message}_id

lib: add known broken test for notmuch_message_get_filename

This will be fixed in the next commit

lib/n_m_get_replies: doc return, initial regression test

We need to to set a query and retrieve the threads to meaningfully
test this function.

test: add regression test for n_m_get_header

This function already catches Xapian exceptions, and we want to make
sure it stays that way.

lib/message: use LOG_XAPIAN_EXCEPTION in n_m_get_header

This is just for consistency, and a small reduction in the amount of
boilerplate.

test: drop use of assert in closed db tests

Instead of printing the same static string for each test, can replace
the assert with something simpler (or at least easier to integrate
into the test suite).

test: remove unused backup_database calls

Since these backups are never restored, they should be safe to remove.

debian: drop ValueRangeProcessor symbols

These are not used since b90d852

test: drop upgrade from v1 tests

These are less crucial since we stopped generating new database
versions and relied primarily on features. They also rely on a
pre-generated v1 database which happens to be chert format. This
backend is not supported by Xapian 1.5.

Also drop the tool gen-testdb.sh, which is currently broken, due to
changes in the testing infrastructure.

lib: migrate from Xapian ValueRangeProcessor to RangeProcessor

This will be mandatory as of Xapian 1.5.  The API is also more
consistent with the FieldProcessor API, which helps code re-use a bit.

Note that this switches to using the built-in Xapian support for
prefixes on ranges (i.e. deleted code at beginning of
ParseTimeRangeProcessor::operator(), added prefix to constructor).

Another side effect of the migration is that we are generating smaller
queries, using one OP_VALUE_RANGE instead of an AND of two OP_VALUE_*
queries.

lib: migrate to post Xapian 1.3.4 compact support

The old API was deprecated in Xapian 1.3.4 and (will be) removed in 1.5.0

doc: make gzipped man pages reproducible

gzip includes the name of the uncompressed file and its modification
timestamp into the compressed archive. The latter makes it hard to
reproduce the generated files bit for bit at a later time, so omit this
information from the archive using the "--no-name" option. This is a
reproducibility best practice, see
https://wiki.debian.org/ReproducibleBuilds/TimestampsInGzipHeaders

Merge branch 'release'

NEWS: update date for release

debian: changelog for 0.30

version: set to 0.30

lib/message: catch exception in n_m_get_thread_id

This allows us to return an error value from the library.

test: add known broken test for n_m_get_thread_id on closed db

This will be fixed in the next commit.

lib: catch error from closed db in n_m_get_message_id

By catching it at the library top level, we can return an error value.

test: add known broken test for error handling on closed database

Based on id:87d05je1j6.fsf@powell.devork.be

build: produce signatures for release candidate tarballs.

Today Defalos on #notmuch asked for a signed tarball for
0.30~rc2. This is a minimal change to support this in the future.  The
question of automagically uploading will need more thought; currently
I like the fact that tags from pre-releases are only pushed manually.

test: fix python 3.8.4 related regression in T210-raw

It seems (at least in 3.8.4~rc1-1 on Debian) that set_content requires
at least one line.

debian: changelog fo 0.30~rc3-1

version: bump to 0.30~rc3

bindings/python-cffi: copy version file into bindings dir

Attempt to avoid breaking "pip install ."

As far as I can tell, we need to have a copy (not just a relative
symlink) of the version file.

doc: update install suggestions for fedora derivatives

Fedora still has an old gmime-devel which is 2.6.x. This is no longer
supported by notmuch. Also apparently dnf is a better choice than yum.

tests: mark sig verification known-broken with session keys on buggy gpgme

We make use of the just-introduced configure test.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

configure: can gpgme can verify signatures when decrypting with a session key?

If https://dev.gnupg.org/T3464 is unresolved in the version of gpgme
we are testing against, then we should know about it, because it
affects the behavior of notmuch.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

test: mark two tests broken on machines with 32 bit time_t

I haven't traced the code path as exhaustively for the SMIME test, but
the expiry date in question is larger then representable in a signed
32 bit integer.

configure: detect 64 bit time_t

Certain tests involving timestamps > 32 bits cannot pass with the
current libnotmuch API. We will avoid this issue for now by disabling
those tests on "old" architectures with 32 bit time_t.

Makefile.global: drop -std=gnu99. C11 (or later) compiler required

Since October 2018 building notmuch has actually required compiler
that knows C11.

Also this -std=gnu99 was not used in code compiled by configure,
so in theory this could have caused problems...

...but no related reports have been sent, perhaps ever.

Both gcc and clang has been shipping compilers supporting C11
(or later) by default for more than four years now.

Therefore, just dropping -std=gnu99 (and not checking C11
compatibility for now, for simplicity) is easiest to do,
and removes inconsistency between configure and build time
compilations.

python-cffi: read version from notmuch version file

This keeps it in sync with the main notmuch version which is less
confusing to users.

debian: changelog stanza for 0.30~rc2-1

version: update to 0.30~rc2

debian/copyright: update to match AUTHORS

update AUTHORS

Yay, we gained a new author, thanks Anton.

Support aborting the atomic context

Since it is possible to use an atomic context to abort a number of
changes support this usage.  Because the only way to actually abort
the transaction is to close the database this must also do so.

Amended by db: Note the limitation requiring close is a limitation of
the underlying notmuch API, which should be fixed in a future notmuch
release.

Make messages returned by Thread objects owned

This reverses the logic of StandaloneMessage to instead create a
OwnedMessage.  Only the Thread class allows retrieving messages more
then once so it can explicitly create such messages.

The added test fails with SIGABRT without the fix for the message
re-use in threads being present.

python/notmuch2: do not destroy messages owned by a query

Any messages retrieved from a query - either directly via
search_messages() or indirectly via thread objects - are owned by that
query. Retrieving the same message (i.e. corresponding to the same
message ID / database object) several times will always yield the same
C object.

The caller is allowed to destroy message objects owned by a query before
the query itself - which can save memory for long-lived queries.
However, that message must then never be retrieved again from that
query.

The python-notmuch2 bindings will currently destroy every message object
in Message._destroy(), which will lead to an invalid free if the same
message is then retrieved again. E.g. the following python program leads
to libtalloc abort()ing:

import notmuch2
db   = notmuch2.Database(mode = notmuch2.Database.MODE.READ_ONLY)
t    = next(db.threads('*'))
msgs = list(zip(t.toplevel(), t.toplevel()))
msgs = list(zip(t.toplevel(), t.toplevel()))

Fix this issue by creating a subclass of Message, which is used for
"standalone" message which have to be freed by the caller. Message class
is then used only for messages descended from a query, which do not need
to be freed by the caller.

python config access: fix style and KeyError bug

This fixes some minor style/pep8 things and adds tests for the new
config support.  Also fixes a bug where KeyError was never raised
on a missing key.

python/notmuch2: add bindings for the database config strings

Update tox.ini for python3.8 and fix pypy3.6

Python 3.8 has been released for a while now, make sure we keep
supporting it correctly.

PyPy 3.6 wasn not configured correctly.

Add missing set methods to tagsets

Even though we use collections.abc.Set which implements all these
methods under their operator names, the actual named variations of
these methods are shockingly missing.  So let's add them manually.

configure: use cffi.FFI().verify() to test buildability of CFFI bindings

Checking existence of pyconfig.h to determine whether CFFI-based
notmuch bindings are buildable is not enough; for example Fedora 32
ships pyconfig.h in python3-libs package, but python3-devel is required
to be installed for the bindings to build.

Executing cffi.FFI().verify() is pretty close to what is done in
bindings/python-cffi/notmuch2/_build.py to get the c code part of the
bindings built.

debian: changelog stanza for 0.30~rc1-1

version: bump to 0.30~rc1

emacs docstrings: consistent indentation, newlines, periods

Fixed emacs docstrings to be consistent. No functional change.

- removed some (accidental) indentation
- removed some trailing newlines
- added trailing periods where missing (some exclusions)

doc: field processor support now always included, adjust manual pages

The features that require field processor support, are now just
documented w/o mentioning **Xapian Field Processors**' is needed
for those.

Replaced "compact" and "field_processor" with "retry_lock" in
build_with config option, as it is currently the only one that
is optionally excluded. The former 2 are now documented as
features always included.

Dropped one 'we' "passive" in notmuch-search-terms.rst. It was the
only one, and inconsistent with rest of the documentation in that
file.

Dropped message about conditional open-ended ranges support, as
those are now always supported.

configure: require python 3.5 for CFFI-based notmuch bindings

Also tell users what the consequences of a "No" answer is when
python version is less than 3.5, cffi or setuptools is missing,
or no pytest >= 3.0 is available.

debian: update debian/copyright

This is based on the updated AUTHORS file.

doc: update AUTHORS file

I tried to be inclusive, and did not delete anyone from Carl's
original file. I also reworded the acknowledgement of Google LLC.

devel: script to calculate a list of authors.

As an initial heuristic, report anyone with at least 15 lines of code
in the current source tree. Test corpora are excluded, although
probabably this doesn't change much about the list of authors
produced.

tweaks to NEWS suggest by Tomi

See id:m27dwp40sx.fsf@guru.guru-group.fi

NEWS: The minimum supported version of Xapian is now 1.4.0

add NEWS for 0.30

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

debian: bump debian revision

second, with binaries upload

debian: Add build dependency on doxygen

debian: add desktop-file-utils dependency

This enables installation of notmuch-emacs-mua.desktop

NEWS: stub for 0.30

debian: add changelog for release candidate

version: bump to 0.30~rc0

bump date in documentation

doc: fix for out-of-tree builds of notmuch-emacs docs

The sphinx-doc include directive does not have the ability to include
files from the build tree, so we replace the include with reading the
files in conf.py. The non-trivial downside of this is that the emacs
docstrings are now defined for every rst source file. They are
namespaced with docstring::, so hopefully there will not be any
surprises. One thing that is noticable is a small (absolute) time
penalty in running sphinx-doc.

configure: check existence of python3 setuptools and dev package

The notmuch2 CFFI-based Python interface is not buildable unless
python3 dev package and python3 setuptools are installed.

Check that these exist in configure (and disable notmuch2 bindings
build if not) so that build of these bindings don't fail when make(1)
is executed.

emacs: Respect `load-prefer-newer` when loading `notmuch-init-file'

Before this change, `load-prefer-newer' was ignored.

Set NOERROR and MUST-SUFFIX arguments of `load' to t, and NOSUFFIX
argument to nil, to preserve the behaviour of the deleted `let' form.

tests/ruby: Ensure that test works for out-of-tree builds

python-cffi: enable out-of-tree builds

This is a simple hack to enable out-of-tree builds, a concern raised
by Tomi in id:m24kzjib9a.fsf@guru.guru-group.fi

This change at least enables "make check" to complete without error,
but I'm sure it could be improved.  I am not expert enough in
setuptools to know how.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
Amended by db per id:87d06usa31.fsf@powell.devork.be

test/test-lib.sh: fix two out of tree test issues

json_check_nodes.py exists in source tree, not in out of tree
build tree. Added -B to the execution so source tree is not
"polluted" by a .pyc file when json_check_nodes.py is executed.

When creating run_emacs.sh make it load .elc files from out of
tree build tree, not from source tree if such files existed.
If existed, those may be outdated, or even created by some other
emacs than the one that was used to build .elc files in out of
tree build dir.

emacs: Use `dolist' instead of `mapcar' for side-effects

As recommended by the byte-compiler.

smime: Index cleartext of envelopedData when requested

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

smime: Pass PKCS#7 envelopedData to node_decrypt_and_verify

This change means we can support "notmuch show --decrypt=true" for
S/MIME encrypted messages, resolving several outstanding broken tests,
including all the remaining S/MIME protected header examples.

We do not yet handle indexing the cleartext of S/MIME encrypted
messages, though.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

crypto: handle PKCS#7 envelopedData in _notmuch_crypto_decrypt

In the two places where _notmuch_crypto_decrypt handles
multipart/encrypted messages (PGP/MIME), we should also handle PKCS#7
envelopedData (S/MIME).

This is insufficient for fully handling S/MIME encrypted data because
_notmuch_crypto_decrypt isn't yet actually invoked for envelopedData
parts, but that will happen in the following changes.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

crypto: Make _notmuch_crypto_decrypt take a GMimeObject

As we prepare to handle S/MIME-encrypted PKCS#7 EnvelopedData (which
is not multipart), we don't want to be limited to passing only
GMimeMultipartEncrypted MIME parts to _notmuch_crypto_decrypt.

There is no functional change here, just a matter of adjusting how we
pass arguments internally.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

cli/reply: Ignore PKCS#7 wrapper parts when replying

When composing a reply, no one wants to see this line in the proposed
message:

    Non-text part: application/pkcs7-mime

So we hide it, the same way we hide PGP/MIME cruft.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

cli/show: If a leaf part has children, show them instead of omitting

Until we did PKCS#7 unwrapping, no leaf MIME part could have a child.

Now, we treat the unwrapped MIME part as the child of the PKCS#7
SignedData object.  So in that case, we want to show it instead of
deliberately omitting the content.

This fixes the test of the protected subject in
id:smime-onepart-signed@protected-headers.example.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

cli: include wrapped part of PKCS#7 SignedData in the MIME tree

Unwrap a PKCS#7 SignedData part unconditionally when the cli is
traversing the MIME tree, and return it as a "child" of what would
otherwise be a leaf in the tree.

Unfortunately, this also breaks the JSON output.  We will fix that
next.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

smime: Identify encrypted S/MIME parts during indexing

We don't handle them correctly yet, but we can at least mark them as
being encrypted.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

lib: index PKCS7 SignedData parts

When we are indexing, we should treat SignedData parts the same way
that we treat a multipart object, indexing the wrapped part as a
distinct MIME object.

Unfortunately, this means doing some sort of cryptographic
verification whose results we throw away, because GMime doesn't offer
us any way to unwrap without doing signature verification.

I've opened https://github.com/jstedfast/gmime/issues/67 to request
the capability from GMime but for now, we'll just accept the
additional performance hit.

As we do this indexing, we also apply the "signed" tag, by analogy
with how we handle multipart/signed messages.  These days, that kind
of change should probably be done with a property instead, but that's
a different set of changes.  This one is just for consistency.

Note that we are currently *only* handling signedData parts, which are
basically clearsigned messages.  PKCS#7 parts can also be
envelopedData and authEnvelopedData (which are effectively encryption
layers), and compressedData (which afaict isn't implemented anywhere,
i've never encountered it).  We're laying the groundwork for indexing
these other S/MIME types here, but we're only dealing with signedData
for now.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

configure: report GMime minimum version in ./configure output

We already report the minimum version for Glib, zlib, and Xapian
development libraries.  For consistency, report it for GMime as well.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

smime: tests of X.509 certificate validity are known-broken on GMime < 3.2.7

When checking cryptographic signatures, Notmuch relies on GMime to
tell it whether the certificate that signs a message has a valid User
ID or not.

If the User ID is not valid, then notmuch does not report the signer's
User ID to the user.  This means that the consumer of notmuch's
cryptographic summary of a message (or of its protected headers) can
be confident in relaying the reported identity to the user.

However, some versions of GMime before 3.2.7 cannot report Certificate
validity for X.509 certificates.  This is resolved upstream in GMime
at https://github.com/jstedfast/gmime/pull/90.

We adapt to this by marking tests of reported User IDs for
S/MIME-signed messages as known-broken if GMime is older than 3.2.7
and has not been patched.

If GMime >= 3.2.7 and certificate validity still doesn't work for
X.509 certs, then there has likely been a regression in GMime and we
should fail early, during ./configure.

To break out these specific User ID checks from other checks, i had to
split some tests into two parts, and reuse $output across the two
subtests.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>

test-lib: mark function variables as local

Several functions in test/test-lib.sh used variable names that are
also used outside of those functions (e.g. $output and $expected are
used in many of the test scripts), but they are not expected to
communicate via those variables.

We mark those variables "local" within test-lib.sh so that they do not
get clobbered when used outside test-lib.

We also move the local variable declarations to beginning of each
function, to avoid weird gotchas with local variable declarations as
described in https://tldp.org/LDP/abs/html/localvar.html.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>