NEWS: finalize release date

debian: changelog for 0.32.1-1

version: bump to 0.32.1

NEWS: add news for $HOME/mail fix

lib/open: restore default database path of $HOME/mail

Although this default worked for "notmuch config get", it didn't work
most other places. Restore the previous functionality, with the
wrinkle that XDG locations will shadow $HOME/mail if they exist.

This fixes a bug reported by Jack Kamm in id:87eeefdc8b.fsf@gmail.com

NEWS: add NEWS for notmuch-{before,after}-tag-hook fixes

emacs: restore tag-changes and query bindings for tag hooks

notmuch-before-tag-hook and notmuch-after-tag-hook are supposed to
have access to two dynamic variables, tag-changes and query, but these
were lost with the switch to lexical binding in fc4cda07 (emacs: use
lexical-bindings in all libraries, 2021-01-13).

Add a variant of Emacs's dlet (not available until Emacs 28) and use
it in notmuch-tag to expose tag-changes and query to the hooks.

test: add known broken tests for notuch-{before,after}-tag-hook

These tests illustrate the bug reported in id:87v97ytd2s.fsf@fastmail.fm

NEWS: add note about fix to notmuch_database_reopen

lib/notmuch_database_reopen: reload some database metadata

In some uses of reopen, new documents and threads maybe have been
added, and e.g. compaction may have changed the uuid.

test: change database from within pre-new hook

Due to the change in the config system, notmuch keeps a notmuch database
open when it would not do so before. Consequently, it can miss changes
to the database which are done from a hook (while notmuch holds the
databse in read only mode). When notmuch itself writes to the database
after that it uses wrong assumptions about the last used doc id etc.

Demonstrate this by triggering an assertion. (This new test succeeds
with notmuch 0.31.4.)

Signed-off-by: Michael J Gruber <git@grubix.eu>
Amended-by: db. Check for both messages

NEWS: start NEWS for 0.32.1

doc: document database.backup_dir

Most users will not need to change this, but documenting it helps
preserve the interface.

doc: document (tersely) the intended behaviour of relative paths.

test: test explicit configuration of backup directory

Including the relative path that was broken until a recent commit.

test: test relative paths for database.hook_dir

lib/config: expand relative paths when reading from database

This makes the treatment of relative paths consistent between the
database and config files.

test: add known broken test for relative setting of mail_root

The behaviour should not change depending on where the configuration
is stored.

lib/config: canonicalize paths relative to $HOME.

Prior to 0.32, notmuch had the (undocumented) behaviour that it
expanded a relative value of database.path with respect to $HOME. In
0.32 this was special cased for database.path but broken for
database.mail_root, which causes problems for at least notmuch-new
when database.path is set to a relative path.

The change in T030-config.sh reflects a user visible, but hopefully
harmless behaviour change; the expanded form of the paths will now be
printed by notmuch config.

test: add known broken test for relative database path in new

This test highlights a bug introduced in 0.32. The new split between
path and mail_root does not properly canonicalize relative paths in
the latter.

debian: add changelog for 0.32-1

NEWS: set date for 0.32 release

version: bump to 0.32

debian: add changelog for 0.32~rc2-1

version: bump to 0.32~rc2

NEWS: fix typo

Spellcheckers, is that like spellchess?

NEWS: summarize changes to emacs interface.

This my attempt at a summary based on git log.

Amended: with suggestions from id:87wnsmkf12.fsf@bernoul.li

NEWS: mention file deletion speedups

It seems a bit silly to have two NEWS entries for one commit, but
there are two potiential audiences.

vim: fix Mail 2.8.0 warning

  Passing an unparsed header field to Mail::Field.new is deprecated and will be removed in Mail 2.8.0. Use Mail::Field.parse instead.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>

test: hide message from moreutils parallel.

The argument --version confuses moreutils parallel, but this is OK,
because its confusing does not include printing "GNU"

test: check for GNU parallel with --version options

The lastest versions of GNU parallel no longer make mention of GNU
within their help output. This causes the test script to mistakenly use
the moreutils parallel execution. In order to fix this, while
maintaining compatibility with previous versions of GNU parallel,
--version should be used.

Signed-off-by: Tobias Backer Dirks <omgitsaheadcrab@gmail.com>

debian: bump changelog version

version: bump to 0.32~rc1

debian: add xapian-tools for tests

xapian-metadata is used by some of the new tests.

lib/config: remove early free in _get_email_from_passwd_file

This (obvious) bug was caused by cut&pasting the code from
notmuch-config.c into the library and adding on a return at the end.

test: replace notmuch_passwd_sanitize with python version

Apparently the -f option to hostname is not portable, and in fact it
does not seem to always behave reasonably in e.g. a chroot.

Python code originally due to Tomi [1], modified by yours truly.

[1]: id:m2lf9fbkug.fsf@guru.guru-group.fi

debian: update d/libnotmuch5

This corresponds to libnotmuch 5.3. It should be backward compatible
because it only adds symbols.

debian: start changelog for 0.32~rc0-1

update version to 0.32~rc0

compat: rename {,notmuch_}canonicalize_file_name

When compat canonicalize_file_name was introduced, it was limited to
C code only because it was used by C code only during that time.

>From 5ec6fd4d, (lib/open: check for split configuration when creating
database., 2021-02-16), lib/open.cc, which is C++, relies on the
existent of canonicalize_file_name.

However, we can't blindly enable canonicalize_file_name for C++ code,
because different implementation has different additional signature for
C++ and users can arbitrarily add -DHAVE_CANONICALIZE_FILE_NAME=0 to
{C,CXX}FLAGS.

Let's move our implementation into a util library.

Helped-by: Tomi Ollila <tomi.ollila@iki.fi>
Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>

ruby: fix ruby 3.1 warnings

  init.c:214:5: warning: ‘rb_cData’ is deprecated: by: rb_cObject.  Will be removed in 3.1. [-Wdeprecated-declarations]

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>

lib/n_d_index_file: check return value from _n_m_add_filename

Ignoring this return value seems like a bad idea in general, and in
particular it has been hiding one or more bugs related to handling
long directory names.

test-lib: unset XDG_CONFIG_HOME

lib/open.cc:_load_key_file will only open xdg-config files in
$XDG_CONFIG_HOME if it's defined, $HOME/.config will be considered if
and only if XDG_CONFIG_HOME not defined.

Let's unset said variable before running the test.

lib: directly traverse postlists in _n_message_delete

This is intended to fix the slow behaviour of "notmuch new" (and possibly
"notmuch reindex") when large numbers of files are deleted.

The underlying issue [1] seems to be the Xapian glass backend spending
a large amount of time in db.has_positions when running queries with
large-ish amounts of unflushed changes.

This commit removes two uses of Xapian queries [2], and replaces them with
an approximation of what Xapian would do after optimizing the
queries. This avoids the calls to has_positions (which are in any case
un-needed because we are only using boolean terms here).

[1] Thanks to "andres" on IRC for narrowing down the performance
bottleneck.

[2] Thanks to Olly Betts of Xapian fame for talking me a through a fix
that does not require people to update Xapian.

perf-tests: add test for removing files.

Without the proposed fix for deletion performance [1], this test is
probably unreasonably slow compared to others at the same
small/medium/large scale.

[1]: id:20210414021627.1236560-3-david@tethera.net

test: put shim at end of LD_PRELOAD path

Certain tools like the address-sanitizer fail if they are not the
first LD_PRELOADed library. It does not seem to matter for our shims,
as long as they are loaded before libnotmuch.

NEWS: user visible config related changes for 0.32

CLI: rename notmuch_config_t to notmuch_conffile_t

The name is a compromise between keeping function names from getting
too long, and avoiding confusion with the newer notmuch_config library
API. Try to make clear that the residual functionality is only about
updating configuration files.

CLI: drop notmuch_config_t from subcommand interface.

At this point it is unused in all subcommands.

CLI/config: remove calls to notmuch_config_open from top level

This will allow simplifying the subcommand interface.

Change the internal API to notmuch_config_open to not tie it to the
implementation of subcommands in notmuch.c.

It also fixes a previously broken test, since notmuch_config_open does
not understand the notion of the empty string as a config file name.

CLI/config: support set/get with split configuration

There are two small code changes. The main one is to retrieve the
possibly updated config file name found during the database opening
call. The second change is to allow empty config file names, as
a (currently broken) way of specifying that configuration should only
be taken from the database.

lib: provide notmuch_config_path

Since the library searches in several locations for a config file, the
caller does not know which of these is chosen in the usual case of
passing NULL as a config file. This changes provides an API for the
caller to retrieve the name of the config file chosen. It will be
tested in a following commit.

CLI+lib: detect missing database in split configurations.

Eventually we want to do all opening of databases in the top
level (main function). This means that detection of missing databases
needs to move out of subcommands. It also requires updating the
library to use the new NO_DATABASE status code.

lib: add NOTMUCH_STATUS_NO_DATABASE

This will allow more precise return values from various open related functions.

CLI/config: default to storing all config in external files

Previously the fact that some configuration options were only stored
in the database (and thus editing the config file had no effect) was a
source of user confusion. This was fixed with the series ending at
d9af0af1646.

On the other hand, the underlying partition of config options into
those stored by default in the database and those stored in the config
file remained. This is also confusing, since now some invocations of
"notmuch config set" modify the config file, and others silently
modify the database instead.

With this commit, it is up to the user to decide which configuration
to modify. A new "--database" option is provided for notmuch config to
enable modifying the configuration information in the database;
otherwise the default is to update an external config file.

CLI/config: drop cached data from notmuch_config_t

The idea is to preserve notmuch_config_t as a thin wrapper for GKeyFile.

CLI/config: drop obsolete notmuch_config_get_*

These are no longer used, replaced by notmuch_config_get.

CLI/notmuch: switch notmuch_command to notmuch_config_get

The goal at this point is to remove the dependence on
notmuch_config_get_* without breaking any existing functionality. This
is a step towards removing notmuch_config_get_* in a future commit.

CLI/config: use notmuch_database_reopen

This allows `notmuch config` to use the common configuration
information carried by the notmuch_database_t opened at the top level.

CLI/config: migrate notmuch_config_open to new config

notmuch_config_open will be preserved in the medium term for use by
the commands that are manipulating the config file directly (config
and setup)

CLI/config: switch "notmuch config list" to merged config

Use the database opened at the top level rather than opening another
notmuch_database_t.

Test output changes because keys are now listed in alphabetical order,
and because a missing database is no longer an error.

CLI/setup: switch to new configuration framework

Most of the changes are the elimination of notmuch_config_t accessor
use. We also migrate some of the diagnostics to the top level where we
are opening the files in question.

test/setup: check file output instead of notmuch config list

This allows verification of comments added to new / updated config
file.

CLI/config: use merged config for "config get"

This commit starts the conversion of notmuch-config.c
functionality (as opposed to just interface) to the new config
framework.

The change to T030-config is because of the move of the
canonicalization database paths from the notmuch_config_t accessor to
the internal function _choose_database_path.

CLI: load merged config at top level

This paves the way for the conversion of the remaining subcommands to
the new configuration framework.

lib/open: canonicalize relative path read from config file

This matches functionality in the the CLI function
notmuch_config_get_database_path, which was previously used in the CLI
code for all calls to open a database.

lib/config: set default for primary user email

This is mainly copying code from the CLI into the lib. The CLI copy
will be deleted in a later commit.

lib/config: set defaults for user full name

This just copies code from from the CLI into the library. New test
infrastructure is needed because apparently we have never tested this
code path.

lib/config: add config_pairs iterators

The layer of shims here seems a bit wasteful compared to just calling
the corresponding string map functions directly, but it allows control
over the API (calling with notmuch_database_t *) and flexibility for
future changes.

lib/config: add notmuch_config_get_values_string

This is to support the less common (at least in the notmuch codebase)
case of accessing a ;-delimited list config value with an arbitrary
string key.

lib: provide notmuch_database_load_config

This is mainly targetted at notmuch-config.c, or similar applications
that don't necessarily need both a configuration file and a database
to exist.

lib/open: pull _load_key_file out of _choose_database_path

Although this increases code duplication, it also increases
flexibility in handling various combinations of missing config file
and missing database.

test: convert random-corpus to use n_d_open_with_config

Remove one more usage of notmuch_config_get_database_path

lib: add missing status strings

lib/open: fix leaks calling _trial_open

_trial_open can't know if the PATH_ERROR return value will cause the
error message to be returned from the library, so it's up the caller
to clean up if not.

CLI/new: use configuration variable for backup directory

The stat is essentially replaced by the mkdir for error detection
purposes.  This changes the default location for backups to make
things tidier, even in non-split configurations. Hopefully there is
not too many user scripts relying on the previous location.

Because the default location may not exist, replace the use of stat
for error detection with a call to mkdir.

lib/config: add configuration variable for backup directory

Like the hook directory, we primarily need a way to communicate this
directory between various components, but we may as well let the user
configure it.

Most of the diff is generalizing choose_hook_dir to work for both
backup and hook directories.

lib/open: fix hook directory calculation in split configuration

Choose sibling directory of xapian database, as .notmuch may not
exist.

libgen.h is already used in debugger.c, so it is not a new dependency
/ potential portability problem.

lib/compact: enable split config

This promotes _choose_xapian_path from static to extern linkage in
order to share between open.cc and database.cc.

CLI/insert: support split database and mail root

The new test is in T055-path-config because it uses the helper
function split_config, and because it seems easier to put the
database path related tests in one place.

lib/open: support XDG_DATA_HOME as a fallback database location.

This changes some error reporting, either intentionally by reporting
the highest level missing directory, or by side effect from looking in
XDG locations when given null database location.

CLI/new: support split database and mail location

This adds new state variable for the mail root, and uses it most
places db_path was used. The notable exception is dumps from
backups. The latter will be dealt with properly in a future commit.

lib/open: check for split configuration when creating database.

The main functionality will be tested when notmuch-new is converted to
support split configuration. Here only the somewhat odd case of split
mail root which is actually symlinked to the database path is tested.

lib: support splitting mail from database location.

Introduce a new configuration value for the mail root, and use it to
locate mail messages in preference to the database.path (which
previously implied the mail messages were also in this location.

Initially only a subset of the CLI is tested in a split
configuration. Further changes will be needed for the remainder of the
CLI to work in split configurations.

lib/open: Use check for existing database by trial opening

This is a bit heavyweight for now, but it will make more sense when we
check multiple locations for the Xapian database.

lib/open: use _finish_open in n_d_create_with_config

This avoids reading the configuration file twice.

lib/open: factor out the second half of n_d_open_with_config

The idea is to allow reuse in n_d_create_with_config. This is
primarily code movement, with some changes in error messages to reduce
the number of input parameters.

lib/open: reuse directory checks from n_d_c_with_config

Make checks more uniform between creating new databases and opening
existing ones.

lib/open: factor out library initialization

This is slightly more tidy, but more importantly it allows for re-use
of this code in n_d_create_with_config. That re-use will be crucial
when we no longer call n_d_open_with_config from
n_d_create_with_config.

lib: remove "path" from notmuch struct

This removes duplication between the struct element and the
configuration string_map entry. Create a simple wrapper for setting
the database path that makes sure the trailing / is stripped.

lib/open: allocate notmuch_t struct early

This gives more flexibility in restructuring the database opening
code.

lib/open: support NOTMUCH_DATABASE environment variable

The additional code is trivial, but making sure we get the priority of
various options correct takes a few tests.

CLI/show: complete conversion to new configuration framework.

In order to open the database in main() for this command, we may need
to re-open it in the (possibly less common) case where crypto options
require write access.

CLI/new: drop the write lock to run the pre-new hook.

This fixes a bug reported in [1]. In principle it could be possible
avoid one of these reopens, but it complicates the logic in main with
respect to creating new databases.

[1]: id:9C1993DF-84BD-4199-A9C8-BADA98498812@bubblegen.co.uk

test: Add tests for write access to database from hooks.

Recent changes to configuration handling meant the pre-new hook was
run while the database was open read only, limiting what could be done
in the hook. Add some known broken tests for this problem, as well as
a regression test for write access from the post-new hook.

lib: support reopening databases for write access.

In the future Xapian will apparently support this more conveniently
for the cases other than READ_ONLY => READ_ONLY

Conceptually this function seems to fit better in lib/open.cc;
database.cc is still large enough that moving the function makes
sense.

lib: save path of xapian database in notmuch struct.

This will allow re-opening in a different mode (read/write
vs. read-only) with current Xapian API. It will also prove useful when
updating the compact functions to support more flexible database
location.

lib: publish API for notmuch_database_reopen

Include the (currently unused) mode argument which will specify which
mode to re-open the database in. Functionality and docs to be
finalized in a followup commit.

test/setup: add check for config exists, but no database.

This code path is not currently tested, and will need updating if the
location of the xapian database changes.

test: add known broken test for long directory bug

In [1] Gregor Zattler explained the results of his hard work
tracking down a bug in notmuch with long directories. This test
duplicates the bug.

[1]: id:20210317194728.GB5561@no.workgroup