Add a few tests for searching LWN emails.

These tests should pass -- but they currently don't.

Signed-off-by: Thomas Schwinge <thomas@schwinge.name>

update for go-release-2011-02-01:
  * M bindings/go/cmds/notmuch-addrlookup.go
    log.Exitf -> log.Fatalf

ruby: Add generated files to .gitignore

Clarify usage of `additional_headers' in test/test-lib.sh:generate_message.

Signed-off-by: Thomas Schwinge <thomas@schwinge.name>

emacs: send notmuch-query stderr to /dev/null

The call-process to notmuch in notmuch-query.el was previously sending
stderr into the output buffer.  This means that if there is any stderr
the JSON parsing breaks.  Unfortunately call-process does not support
sending stderr to a separate buffer or to the minibuffer [0], but it
does support sending it to /dev/null.  So we do that here instead.

[0] a bug was filed against emacs (#7842)

new: Print progress estimates only when we have sufficient information

Without this patch, it might happen that the remaining time or processing
rate were calculated just after start where nothing was processed yet.
This resulted into division by a very small number (or zero) and the
printed information was of little value.

Instead of printing nonsenses we print only that the operation is in
progress. The estimates will be printed later, after there is enough data.

Makefile: Quote variables used as filenames in shell commands

This allows support for filenames with spaces in them.

configure: Drop global setting of IFS (without space in it).

This was originally intended to help support filenames with spaces in
them, but this actually breaks things when someone sets a command with
a space in it, (such as CC="ccache cc").

Instead, we now only set a custom IFS when acting on the
newline-separated list of files from /sbin/ldconfig.

emacs: View the output of pipe command when it fails

Previously, the user didn't know whether the pipe command succeeded or
not. It was only possible to find it out by manually inspecting
the work done (or not done) by the command or by manually switching to
*notmuch-pipe* buffer and determine it from command output. For this
the user had to first find the text corresponding to the last run of
pipe command as the buffer accumulated the output from all pipe commands.

This patch changes the following. The *notmuch-pipe* buffer is erased
before every pipe command so it contains only the output from the last
command. Additionally, when the command failed, the *notmuch-pipe* buffer
is shown and an error message is displayed.
with the output of pipe command.

test: Make it easier to resolve conflicts when adding new tests

Currently, there are two places in the test framework that contain very
long list on a single line. Whenever a test is added (or changed) in
several branches and these branches are merged, it results in conflict
which is hard to resolve because one has to go through the whole long
line to find where the conflict is.

This patch splits these long lists to several lines so that the
conflicts are easier to resolve.

Fix installation of zsh completion

configure: add options to disable emacs/zsh/bash and choose install dir.

add --bashcompletiondir and --zshcompletiondir (like --emacslispdir) to choose
installation dir for bash/zsh completion files

Make some features optional:
  --without-emacs / --with-emacs=no do not install lisp file
  --without-bash-completion / --with-bash-completion=no  do not install bash
files
  --without-zsh-completion / --with-zsh-completion=no do not install zsh files
By default, everything is enabled. You can reenable something with
  --with-feature=yes

new: Enhance progress reporting

notmuch new reports progress only during the "first" phase when the
files on disk are traversed and indexed. After this phase, other
operations like rename detection and maildir flags synchronization are
performed, but the user is not informed about them. Since these
operations can take significant time, we want to inform the user about
them.

This patch enhances the progress reporting facility that was already
present. The timer that triggers reporting is not stopped after the
first phase but continues to run until all operations are finished. The
rename detection and maildir flag synchronization are enhanced to report
their progress.

new: Add all initial tags at once

If there are several tags applied to the new messages, it is beneficial
to store them to the database at one, because it saves some time,
especially when the notmuch new is run for the first time.

This patch decreased the time for initial import from 1h 35m to 1h 14m.

Do not defer maildir flag synchronization for new messages

This is a simplified version of a patch originally by Michal Sojka
<sojkam1@fel.cvut.cz> which is designed to have the same performance
benefits. Michal said the following:

  When notmuch new is run for the first time, it is not necessary to
  defer maildir flags synchronization to later because we already know
  that no files will be removed.

  Performing the maildinr flag synchronization immediately after the
  message is added to the database has the advantage that the message
  is likely hot in the disk cache so the synchronization is faster.
  Additionally, we also save one database query for each message,
  which must be performed when the operation is deferred.

  Without this patch, the first notmuch new of 200k messages (3 GB)
  took 1h and 46m out of which 20m was maildir flags
  synchronization. With this patch, the whole operation took only 1h
  and 36m.

Unlike Michal's patch, this version does the deferral for any new
message, rather than doing it only on the first run of "notmuch new".

vim: Get user email address from notmuch config file.

Here's a bitty patch to the vim plugin; it now calculates the primary email
of the user based on a call to notmuch config.  There's still a lot of work
that needs to get done on notmuch.vim, e.g., the ability to have multiple
emails/accounts.

lib: Save and restore term position in message while indexing.

This fixes the recently addead search-position-overlap bug as
demonstrated in the test of the same name.

Add test demonstrating a position overlap bug.

Currently, whenever we call index_terms multiple times for a single
field, the term generator is being reset to position 0 each time. This
means that with text such as:

To: a@b.c, x@y.z

one can get a bogus match by searching for:

To: a@y.c

Thanks to Mark Anderson for reporting the bug, (and providing a nice,
minimal test case that inspired what is used here).

notmuch search: Clean up some memory leaks during search loop.

With talloc, we were already freeing all memory by the time we exited
the loop, but that didn't help with excess use of memory inside the
loop, (which was mostly from tallocing some objects with the incorrect
parent).

Thanks to Andrew Tridgell for sitting next to me and teaching me to
use talloc_report_full to find these leaks.

Migrate to goconfig pkg

bindings/go: Add a todo file

A minor, cosmetic change

Just trying to keep the line lengths in check.

Initial import of Go bindings for notmuch

TODO: Note that folder: has now been implemented.

This feature has been mentioned in the TODO file (more than once) for
quite some time now.

ruby: Add wrapper for message_get_filenames

ruby: Add wrappers for maildir sync. interface

New wrappers:
notmuch_message_maildir_flags_to_tags(): MESSAGE.maildir_flags_to_tags
notmuch_message_tags_to_maildir_flags(): MESSAGE.tags_to_maildir_flags

ruby: Add wrappers for query_get_s{ort,tring}

New wrappers:
notmuch_query_get_sort(): QUERY.sort
notmuch_query_get_query_string(): QUERY.to_s

Add documentation for the recently added folder-based searching.

Augmenting both the builtin help as well as the manual page.

Add support for folder-based searching.

A new "folder:" prefix in the query string can now be used to match
the directories in which mail files are stored.

The addition of this feature causes the recently added
search-by-folder tests to now pass.

test: Add new tests for folder-based searching.

This is a new feature which is not implemente yet, so these tests mostly
fail currently. A subsequent commit will add the feature and cause these
tests to start passing.

These tests verify that we can search for containing folders of mail files
by word or by phrase and that the search terms are updated correctly when
directories are renamed.

Fix misspelling in a comment.

Just a simple change I noticed in passing.

test/basic: Ignore new files ending in ~

We don't need to complain that temporary editor backups are not added
to the list of tests to be run.

Tighten up a memory allocation.

Using the local talloc context ensures that the memory we are using
here will be freed shortly, (rather than hanging on for a long time
with the notmuch database object).

Correct some minor typos in a comment

Nothing too important here. Just some misspellings I noticed while reading
nearby code.

python: Update metainformation to point to new URL and version number

Convert the meta information to point to the notmuchmail.org repository, rather
than the old cnotmuch location. I will delete the "cnotmuch" package
from http://pypi.python.org/pypi/cnotmuch and create a new "notmuch"
package there that contains the current versions.

Also bump the version number to 0.4. I will need to upgrade the API
first before I can release the 0.5 of the bindings, there are still some
methods missing.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

Optimize thread search using matched docid sets.

This reduces thread search's 1+2t Xapian queries (where t is the
number of matched threads) to 1+t queries and constructs exactly one
notmuch_message_t for each message instead of 2 to 3.
notmuch_query_search_threads eagerly fetches the docids of all
messages matching the user query instead of lazily constructing
message objects and fetching thread ID's from term lists.
_notmuch_thread_create takes a seed docid and the set of all matched
docids and uses a single Xapian query to expand this docid to its
containing thread, using the matched docid set to determine which
messages in the thread match the user query instead of using a second
Xapian query.

This reduces the amount of time required to load my inbox from 4.523
seconds to 3.025 seconds (1.5X faster).

Update test suite for 7 tests that were recently fixed.

These tests had been broken, but were fixed by the preceding commit,
so update the test suite to print PASS rather than FIXED for these.

notmuch search: Fix to display authors in date order.

Previously, the authors of the thread were displayed in
reverse-chronological order, which was fairly confusing.

lib: Set thread subject at the same time as setting thread->{oldest,newest}

We really want to change the thread subject at the same time we set
the date, (if the sort order indicates this is necessary). The
previous code for setting the thread subject was sensitive on the
query sort when adding matching messages. An independent bug fix is
about to change that query sort order, so we remove the dependency on
it here.

Revert "test: Break on test script (or other) error"

This reverts commit f22a7ec1e28d1264cf9d67d78796b8ab22e09a35.

Interrupting the test suite due to an actual bug in a test script
would be just fine, but interrupting the run of the entire test suite
at the first test failure is unacceptable.

test: Leave tmp.<testname> for broken tests

Previously, this directory was only preserved for failing tests. But
it's important to be able to easily debug known-broken tests, so
preserve the actual vs. expected output for those as well.

Make author order tests more strict.

Use varying dates in the test messages to test the order authors are
listed in.  Add tests with repeated author names and unusual date
ordering.  Most of these are broken at the moment, but will be fixed
shortly.

Edited-by: Carl Worth <cworth@cworth.org>: Also update the expected
results for existing emacs tests that currently codify the incorrect
author ordering, (and similarly note them as broken in the current
test suite).

Fix handling of broken tests.

Make sure to close the subtest for test_expect_equal_failure, just
like in test_expect_equal.

emacs: Remove over-eager regular expressions from notmuch-wash-tidy-citations.

The removed expressions, which were used to ensure that citations were
both preceded and followed by a blank line, were poorly implemented
and caused a regexp stack overflow on messages more than a few
thousand lines long.

emacs: Improve the display of truncated authors.

Incremental search does not match strings that span a
visible/invisible boundary. This results in failure to correctly
isearch for authors in `notmuch-search' mode if the name of the author
is split between the visible and invisible components of the authors
string. To avoid this, attempt to truncate the visible component of
the authors string on a boundary between authors, such that the
entirety of an author's name is either visible or invisible.

emacs: Use truenames for Fcc paths.

Appease the test suite by using the true name for the Fcc directory
path, otherwise a value for `notmuch-database-path' which includes
symbolic links causes test suite failures.

test: Ignore files created during test failures.

When a test fails, a tmp.<testname> file is left behind. These files
are useful for the person debugging the test failure, but are never
anything we want to commit.

Edited-by: Carl Worth <cworth@cworth.org>: Changed from tmp.emacs to
tmp.* and added explanation in the commit message.

notmuch new: Scan directory whenever fs mtime is not equal to db mtime

Previously, we would only scan a directory if the filesystem
modification time was strictly newer than the database modification
time for the directory. This would cause a problem for systems with an
unstable clock, (if a new mail was added to the filesystem, then the
system clock rolled backward, "notmuch new" would not find the message
until the clock caught up and the directory was modified again).

Now, we always scan the directory if the modification time of the
directory is not exactly the same between the filesystem and the
database. This avoids the problem described above even with an
unstable system clock.

Fix to index the "Re" term present in any subject.

This was a misfeature where notmuch had extra code that just threw
away legitimate information. It was never indexing an initial "Re"
term in a subject. But some users have legitimately wanted to search
for this term.

The original code was written this way merely for strict compatiblity
with the indexing performed by sup, but we're not taking advantage of
that now anyway.

notmuch search: Fix missing final newline in "notmuch search --output=tags"

As mentioned in the recent test commits, this also fixes the missing
'[' and ']' characters in the --format=json variant of "notmuch search
--output=tags" as well.

test: Add --format=json testing to the "notmuch search --format" tests.

This testing *does* capture the bug of missing '[' and ']' characters
int "notmuch search --output=tags" case. This is another manifestation
of the same bug causing the missing final newline (as mentioned in the
previous commit).

test: Add simple tests for "notmuch search --output=<>"

This code simply wasn't being exercised by the test suite before, so
this will be useful.

Meanwhile, there's currently a bug in "notmuch search --output=tags"
in that it doesn't print a final newline. But the current test suite
isn't able to catch this bug since the $() construct of the shell
doesn't preserve the distinction of whether the final newline is
present or not.

TODO: Note missing keybindings for next/previous thread in emacs client.

Seems a fairly obvious shortcoming to have survived this long.

compatibility with emacs22

Emacs22 lacks apply-partially and mouse-event-p, so define them if emacs
version is less than 23.  With this change, I was able to begin using
notmuch in emacs22.

The definitions of apply-partially and mouse-event-p are copied from
the emacs 23 distribution, (which is distributed under the GPLv3+ just
as notmuch).

TODO: Add several items recently mentioned on the mailing list.

Getting things listed here means that I can safely archive away those
messages without worrying that the ideas will get lost.

test: Don't print a test result for preliminary test setup

This test script does some initial test setup (generating a few
messages), which is all well and good, but we don't need to print that
as a test result---particularly since the test result was effectively
hard-coded to always pass.

test: Fix bugs detected thanks to the previous commit

test: Detect unfinished subsets

When test_begin_subtest is not followed by corresponding test_expect_equal,
the output of the rest of the test script is errornously suppressed. Add
code to detect these bugs in test scripts.

test: Break on test script (or other) error

Break notmuch-test whenever a test script returns non-zero status.
This happens either when some test from the script fails or when there
is an error in the script.

This is especially useful in the latter case since the error may not
appear in the final aggregated results.

test: Add trailing newline to error messages

The newline was removed from say_color in commit 222926ab to allow
printing test status in the beginning of the line. Error messages are
never followed by other text so we add the newline to error function.

test: Better handling of stdout and stderr

Git-style tests (test_expect_success etc.) suppress stdout and stderr
unless -v is given. Notmuch-style tests (created by test_begin_subtest
and test_expect_equal) do not have this behavior so implement it the
same.

Additionally, for both test styles, the test-lib.sh is changed so that
the content of suppressed stdout and stderr is shown in case of failed
test.

Finally a test for this functionality is added to basic tests.

emacs: Use `view-mode' when examining raw messages.

Explained-by: Carl Worth: This gives convenient keybindings for
navigating the file and for quitting from the buffer, (since, with a
raw message file the user will generally want to just view the
message, not edit it).

configure: Add explicit check for glib >= 2.14

For cases where GMime is present, but happy with glib 2.12, for example.

configure: Use pkg-config --exists rather than --modversion

With --modversion we were asking for output that we were just throwing
away anyway. The --exists option does just what we want, (no output
and communivating only via return value).

Also, --exists allows for testing versions of the package as well.

lib: Fix missing initialization of status field.

This could have been a problematic bug. Fortuinately "gcc -O2" warns
about it.

lib: Add two missing static qualifiers

The debian packaging is nice enough to notice when we accidentally
leak private symbols to the public interface.

debian: Update list of symbols for libnotmuch

This release adds three new functions to the library interface.

debian: Add changelog entry for 0.5

Just pulling things from NEWS as usual.

Increment notmuch version to 0.5

The big change here is the support for maildir-flag synchronization.

But there are a number of other thigns as well---library support for
multiple filenames, new ruby bindings, improvements to the vim
interface, and a few tweaks to the emacs interface.

Increment library version to 1.3.0

For the addition of three functions:

notmuch_message_get_filenames
notmuch_message_tags_to_maildir_flags
notmuch_message_maildir_flags_to_tags

NEWS: Add notes for 0.5 release.

Which is ready to go now.

config: Fix confusing of "tag" and "flag" oin documentation.

It has been very difficult to get all of these right. I would not be
surprised if I've still missed some.

emacs: add stash thread-id function to notmuch-search mode

This add a "stash-map" for search-mode, just like in show-mode, and
adds one function, bound to "i" to stash the thread-id of the current
selected thread.

Couldn't think of the correct way to stash other thread info, so I
didn't add any other stash functions for now.

emacs: mv notmuch-{show,common}-do-stash

Here we move the notmuch-show/notmuch-show-do-stash function to
notmuch-lib/notmuch-common-do-stash.  Nothing in this function is
notmuch-show mode specific, so this move will make it cleaner to be
used by other modes (such as notmuch-search).

emacs: Improve the definition and use of `notmuch-fcc-dirs'.

Re-work the declaration and definition of `notmuch-fcc-dirs'. The
variable now allows three types of values:

- nil: no Fcc header is added,

- a string: the value of `notmuch-fcc-dirs' is the name of the
  folder to use,

- a list: the folder is chosen based on the From address of the
  current message using a list of regular expressions and
  corresponding folders:

     ((\"Sebastian@SSpaeth.de\" . \"privat\")
      (\"spaetz@sspaeth.de\" . \"OUTBOX.OSS\")
      (\".*\" . \"defaultinbox\"))

  If none of the regular expressions match the From address, no
  Fcc header will be added.

emacs: Use the header line to show the subject of the thread.

emacs: Simplify subjects more aggressively.

Remove 're: ' or 'Re: ' from anywhere within a subject line rather
than just at the beginning. This is to accommodate threads where a
mailing list sometimes inserts a subject prefix.

For example, if a thread has the subjects:

    [Orgmode] org-indent, org-inlinetask: patches on github
    Re: [Orgmode] org-indent, org-inlinetask: patches on github
    [Orgmode] Re: org-indent, org-inlinetask: patches on github

the last of these would not have been considered the same and would
therefore have been shown.

emacs: Elide the display of repeated subjects in thread display mode.

Collapsed messages do not show a "Subject:" line if the subject is the
same as that of the previous message.

test: Update emacs tests for fix to counting of signature lines.

The recent bug fix invalidated some expected test results. Fix them up.

emacs: Correctly count the number of lines in a signature.

Update of the spec file to the 0.4 release.

tags_to_maildir_flags: Fix to preserve existing, unsupported flags

This is to prevent notmuch from destroying any information the user
has encoded as flags in the maildir filename. Tests are also added to
the test suite to verify the documented behavior.

notmuch_message_tags_to_maildir_flags: Do nothing outside of "new" and "cur"

Some people use notmuch with non-maildir files, (for example, email
messages in MH format, or else cool things like using sluk[*] to suck
down feeds into a format that notmuch can index).

To better support uses like that, don't do any renaming for files that
are not in a directory named either "new" or "cur".

[*] https://github.com/krl/sluk/

lib: Be honest in the documentation of the maildir functions

I had originally hoped for better semantics, such as doing nothing in
non-maildir directories, and preserving unknown maildir flags that
happen to be present.

We could still do those things, of course, but for now, remove them
from the documentation since the implementation does not do these
things yet.

notmuch setup: Fix to add maildir group (with comment) to existing file

The intent of "notmuch setup" is that it adds new, documented sections
to configuration files that were created before such sections were
defined. But to make this work, we have to explicitly set an option
in the maildir group if it didn't exist previously.

test: Move corpus emails into maildir directory structure

Now that we have maildir synchronization turned on by default, it's
advantageous to make all of the tests exercise it as much as possible.

test: Fix emacs FCC test to account for new maildir synchronization

The FCC code saves a message in maildir format, and sets the S flag by
default, so now, automatically, FCC messages will not show up as
"unread", (which seems natural enough).

Enable maildir synchronization by default.

This is a useful feature that most people should want, so enable it by
default, (still allowing customization to disable it of course).

notmuch config: Add more documentation for maildir.synchronize_flags

Including details on which actual flags are synchronized with which tags.

notmuch setup: Don't prompt about maildir synchronization

This synchronization is one of those features that should just happen
automatically. We allow for customization in case someone *really*
wants to turn it off, but we don't need to prompt for this
interactively.

People with special needs can find the configuration file on their
own.

notmuch_message_tags_to_maildir_flags: Don't exit on failure to rename.

It is totally legitimate for a non-maildir directory to be named "new"
(and not have a directory next to it named "cur"). To support this
case at least, be silent about any rename failure.

test: Drop test for propagating flag changes from one file to another

There's nothing in the current API documentation that would suggest
the behavior being tested here. Attempt to implement this could have
some nasty side effects, (such as notmuch_message_maildir_flags_to_tags
implicitly calling notmuch_message_tags_to_maildir_flags and maybe
even opening up some bad looping possibilities).

Much better to stick with what we have documented, which we believe will
actually be useful, (and easy enough to comprehend).

notmuch_message_tags_to_maildir_flags: Fix to rename multiple files

This function was documented as modifying every filename associated
with the message. Fix it to actually do that.

notmuch_filenames_create: Take a reference to underlying filename list

The notmuch_filenames_t object might easily outlive the original object
owning the filename list. So take a talloc reference to keep things safe.

maildir_flags_to_tags: Avoid interpreting "no info" as "no flags set".

If a filename has no maildir info at all, (that is, it does not
contain the sequence ":2,"), we consider this distinct from a filename
with an empty maildir info, (the ":2," separator is present, but no
flags characters follow).

Specifically, we regard a missing info field as providing no
information, so tags will remain unchanged. On the other hand, an info
field that is present but has no flags set will cause various tags to
be cleared, (or in the case of "unread", added).

This fixes the "remove info" case of the maildir-sync tests in the
test suite.

notmuch new: Defer maildir_flags synchronization until after removals

When a file in the mailstore is renamed, this appears to "notmuch new"
as both an added file and a removed file (for the same message). We
want the synchronization of the maildir_flags to reflect the final
state, (after the rename is complete). Therefore, it's incorrect to
perform the synchronization immediately after adding a new
file. Instead we queue up these synchronizations (by message ID[*])
and perform them after the removals are complete.

With this change, the "dump/restore" case of the maildir-sync tests,
as well as the recent "remove 'S'" case both now pass where they were
failing before.

Interestingly, the "remove info" test was passing before, but now
fails. This is actually due to a separate bug, (and the bug just fixed
was masking it, by preventing the test from performing as desired).

[*] It's important to queue by message ID---queueing actual message
objects does not work since the message objects will retain stale data
such as the old filenames.

lib: Document that absence of maildir flags can also remove/add tags

Previously the documentation of notmuch_message_maildir_flags_to_tags
suggested that the presence of a flag would cause tags to be added,
(or in the case of "unread", removed). But the case of absent maildir
flags was not explicitly described.

What we actually want, is that for supported flags, the absence of the
flag in all messages causes the corresponding tag to be removed,
(or in the case of "unread", added). So document that explicitly.

This is the case recently added to the test suite as a failing test,
(so we'll need to do bug fixing before the documentation is honest
here).

test: Add a new test that removal of a maildir flag also changes tags

This test exposes an existing bug, so is currently failing.

Fix notmuch_message_tags_to_maildir_flags to effect rename immediately

We have tests to ensure that when the notmuch library renames a file
that that rename takes place immediately in the database, (without
requiring something like "notmuch new" to notice the change).

This was working when the code was first added, but recently broke in
the reworking of the maildir-synchronization interface since the
tags_to_maildir_flags function can no longer assume that it is being
called as part of _notmuch_message_sync.

Fortunately, the fix is as simple as adding an explicit call to
_notmuch_message_sync.

Fix notmuch_message_maildir_flags_to_tags to iterate over filenames

As documented, this function now iterates over all filenames for the
message, computing a logical OR of the flags set on the filenames,
then uses the final result to set tags on the message.

This change fixes 3 of the 10 maildir-sync tests that have been
failing since being added.