test: add regression test for n_d_{begin,end}_atomic

Xapian currently succeeds to begin/end a transaction on a closed database,
or at least does not throw an exception. Make the test robust against
this changing.

test: regression test for n_d_upgrade

The logic is that if it's acceptable to return SUCCESS for read only
database, it's acceptable for a closed one.

lib/n_d_needs_upgrade: handle error return from n_d_get_version

Also clarify documentation of error return from n_d_needs_upgrade.

test: add known broken test for n_d_needs_upgrade

It's a bit arbitrary which value to return for errors, but the same
argument as for read only databases applies for errors.

test: add regression tests for notmuch database destroy

Either an open or closed database should be ok to destroy

test: regression test for closing a closed database

This does not currently throw an error, and it should stay that way.

lib/n_d_get_version: catch exceptions and clarify the API

notmuch_database_get_version previously returned 0 on some errors, but
did not document this. Luckily 0 is not a valid database version.

lib: move deallocation of memory from n_d_close to n_d_destroy

In order to mimic the "best effort" API of Xapian to provide
information from a closed database when possible, do not
destroy the Xapian database object too early.

Because the pointer to a Xapian database is no longer nulled on close,
introduce a flag to track whether the notmuch database is open or not.

test: add known broken test for n_d_get_version on closed db

This should not crash, but it does currently.

test: regression tests for n_d_status_string and n_d_get_path

These do not crash on a closed database, and we want to keep it that
way.

Start a new file of tests as T560-lib-error was starting to get unwieldy.

lib: fix exception messages for n_m_message_*

The original generic handler had an extra '%s' in the format
string. Update tests that failed to catch this because the template to
print status strings checked 'stat', which was not set.

test: sanitize line numbers in exception reports

Prevent test suite churn when reported line numbers change.

emacs: notmuch-search: avoid wiping out buffer-local variables

lib: fix return value for n_m_reindex

Also update the documentation for the behaviour of n_m_get_thread_id
that this fix relies on.

test: add known broken test for n_m_reindex on closed db

This is another case where the code should not call INTERNAL_ERROR.

test: regression for retrieving closed db from message

This is actually one of the few potentially useful things you can do
with a message belonging to a closed database, since in principle you
could re-open the database.

test: regression test for destroying message with closed db

This should be fine because the message belongs to the
database (talloc context wise).

test: regression tests of n_m_freeze and n_m_thaw on closed db

Neither of these accesses the database, so should be safe. Add the
tests to catch any changes in exception throwing.

lib: handle xapian exception in n_m_remove_all_tags

At least the exception we already catch should be reported properly.

test: add broken test for n_m_remove_all_tags

The Xapian exception is actually caught here, but the NULL return is
not dealt with properly.

test: add regression test for n_m_maildir_flags_to_tags

This function currently catches at least the obvious Xapian exceptions
and we want to keep it that way.

cli/new: replace newly deprecated n_m_has_maildir_flag

Boolean return values have no out-of-band-values to signal errors. The
change here is that a (somewhat unlikely) fatal error after indexing
will now be caught.

lib: add notmuch_message_has_maildir_flag_st

Initially the new function is mainly tested indirectly via the
wrapper.

test: add regression test for notmuch_message_has_maildir_flag

This passes the NULL return inside _ensure_maildir_flags does not
break anything. Probably this should be handled more explicitely.

configure: replace multiple redirects with redirected block

This belatedly implements Tomi's suggestion from

     id:m25zaukv6u.fsf@guru.guru-group.fi

bindings/ruby: replacy use of deprecated notmuch_message_get_flag

Depending on the flag, this actually can return an errror, so raise a
ruby exception if so.

lib/thread: replace use of deprecated notmuch_message_get_flag

This adds one more reason why _notmuch_thread_create might return
NULL, but those were not previously enumerated, so no promises are
broken.

lib/add-message: drop use of deprecated notmuch_message_get_flag.

As a side effect, we revert the switch from notmuch_bool_t to bool
here. This is because those two types are not actually compatible when
passing by reference.

cli/show: replace deprecated notmuch_message_get_flag

This can be seen as moving an abort out of the library, into the CLI
where we can both print to stderr and shut the process down without
ill effect.

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.