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.

lib: Add new, public notmuch_message_get_filenames

This augments the existing notmuch_message_get_filename by allowing
the caller access to all filenames in the case of multiple files for a
single message.

To support this, we split the iterator (notmuch_filenames_t) away from
the list storage (notmuch_filename_list_t) where previously these were
a single object (notmuch_filenames_t). Then, whenever the user asks
for a file or filename, the message object lazily creates a complete
notmuch_filename_list_t and then:

For notmuch_message_get_filename, returns the first filename
in the list.

For notmuch_message_get_filenames, creates and returns a new
iterator for the filename list.

lib: Add new implementation of notmuch_filenames_t

The new implementation is simply a talloc-based list of strings. The
former support (a list of database terms with a common prefix) is
implemented by simply pre-iterating over the terms and populating the
list. This should provide no performance disadvantage as callers of
thigns like notmuch_directory_get_child_files are very likely to
always iterate over all filenames anyway.

This new implementation of notmuch_filenames_t is in preparation for
adding API to query all of the filenames for a single message.

lib: Remove the notion of TAGS_INVALID

This rather ugly hack was recently obviated by the removal of the
notmuch_database_set_maildir_sync function. Now, clients must make
explicit calls to do any syncrhonization between maildir flags and
tags. So the library no longer needs to worry about doing inconsistent
synchronization while a message is only partially added.

lib: Rework interface for maildir_flags synchronization

Instead of having an API for setting a library-wide flag for
synchronization (notmuch_database_set_maildir_sync) we instead
implement maildir synchronization with two new library functions:

notmuch_message_maildir_flags_to_tags
  and   notmuch_message_tags_to_maildir_flags

These functions are nicely documented here, (though the implementation
does not quite match the documentation yet---as plainly evidenced by
the current results of the test suite).

Avoid abbreviation, preferring notmuch_config_get_maildir_synchronize_flags

Since the name of the configuration parameter here is:

maildir.synchronize_flags

the convention is that the functions to get and set this parameter
should match it in name. Hence:

       notmuch_config_get_maildir_synchronize_flags

etc. (as opposed to notmuch_config_get_maildir_sync).

test: Rework recently-added additional maildir-sync tests

These needed to be changed to be brought up to the current state of
the maildir-sync tests. This includes style changes, but also the
elimination of any assumption about pre-existing message filenames,
(such as msg-003) which actually don't exist anymore.

Also, the known broken tests are changed to emit FAIL rather than
BROKEN simply to make them easier to fix, (so that they print the
current problems rather than hiding them).

Finally, an additional test is added to ensure that when a duplicate
file is added without flags, it doesn't invalidate flags from other
duplicates, (instead the flags are effectively merged).

test: More maildir synchronization tests

Add maildir synchronization tests for multiple messages with the same
message-id. As this is not yet implemented in notmuch, some of these
teste are marked as BROKEN.

I use $(< ) operator to avoid fiddling with stripped trailing newlines
from test results which happens when output+=$(command) is used.

lib: Remove the synchronization of 'T' flag with "deleted" tag.

Tags in a notmuch database affect all messages with the identical
message-ID. But maildir tags affect individual files. And since
multiple files can contain the identical message-ID, there is not a
one-to-one correspondence between messages affected by tags and flags.

This is particularly dangerous with the 'T' (== "trashed") maildir
flag and the corresponding "deleted" tag in the notmuch
database. Since these flags/tags are often used to trigger
irreversible deletion operations, the lack of one-to-one
correspondence can be potentially dangerous.

For example, consider the following sequence:

  1. A third-party application is used to identify duplicate messages
     in the mail store, and mark all-but-one of each duplicate with
     the 'T' flag for subsequent deletion.

  2. A "notmuch new" operation reads that 'T' flag, adding the
     "deleted" flag to the corresponding messages within the notmuch
     database.

  3. A subsequent notmuch operation, (such as a "notmuch dump; notmuch
     restore" cycle) synchronized the "deleted" tag back to the mail
     store, applying the 'T' flag to all(!) filenames with duplicate
     message IDs.

  4. A third-party application reads the 'T' flags and irreversibly
     deletes all mail messages which had any duplicates(!).

In order to avoid this scenario, we simply refuse to synchronize the
'T' flag with the "deleted" tag. Instead, applications can set 'T' and
act on it to delete files, or can set "deleted" and act on it to
delete files. But in either case the semantics are clear and there is
never dangerous propagation through the one-to-many mapping of notmuch
message objects to files.

test: Rework testing of maildir-synchronization feature.

This change reworks these tests in several ways:

1. Bring tests into "new" test style preferring test_expect_equal over
   test_expect_success in almost all cases.

2. Don't emit test results for intermediate items not actually being
   tested, (things like "no new messages", "search for message",
   etc.). Those things are already covered by existing tests such as
   "basic" or "search" and only serve to obscure what's actually being
   tested.

3. Change sense of the test showing failure to rename a file from
   "new" to "cur" when "cur" doesn't exist.

   In this case, notmuch should detect that this is not a maildir and
   should not attempt to do any renaming of the file.

4. Extend dump/restore test to also exercise addition of tag, not just
   removal.

Both items #3 and #4 above show shortcomings in the current
implementation. These are currently resulting in test results of FAIL
and indicate bugs that need to be fixed.

Tests for maildir synchronization

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

Make maildir synchronization configurable

This adds group [maildir] and key 'synchronize_flags' to the
configuration file. Its value enables (true) or diables (false) the
synchronization between notmuch tags and maildir flags. By default,
the synchronization is disabled.

Maildir synchronization

This patch allows bi-directional synchronization between maildir
flags and certain tags. The flag-to-tag mapping is defined by flag2tag
array.

The synchronization works this way:

1) Whenever notmuch new is executed, the following happens:
   o New messages are tagged with configured new_tags.
   o For new or renamed messages with maildir info present in the file
     name, the tags defined in flag2tag are either added or removed
     depending on the flags from the file name.

2) Whenever notmuch tag (or notmuch restore) is executed, a new set of
   flags based on the tags is constructed for every message and a new
   file name is prepared based on the old file name but with the new
   flags. If the flags differs and the old message was in 'new'
   directory then this is replaced with 'cur' in the new file name. If
   the new and old file names differ, the file is renamed and notmuch
   database is updated accordingly.

   The rename happens before the database is updated. In case of crash
   between rename and database update, the next run of notmuch new
   brings the database in sync with the mail store again.

lib: Return added message even if it already was in the database

test: Don't strip portions of test name after '-' for temporary files.

We have test names like maildir-sync now, so it's cleaner if the
temporary files created are named things like maildir-sync-10.out
rather than maildir-10.out. Presumably the extra stripping here came
from naming conventions in git's test suite.

Merge in ruby bindings.

Thanks to Ali Polatel for these bindings. This code was fetched from
the ruby branch of:

git://github.com/alip/notmuch.git

vim: include own improved git-diff syntax

The old one wasn't working at all on newer vims.

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

vim: run(): optimize non-debug path

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

vim: use mailx for sending

Possilby used by more systems, and besides the code wasn't really
working properly anyway.

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

vim: add option to mark as read + archive

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

vim: remove add_remove_tags_on_screen()

It's not working properly; the current message is jumping around and the
tags not really added/removed properly.

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

vim: cleanup search syntax

It was *sloooooow*.

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

vim: cleanup search buffer

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

vim: add archive support from 'show'

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

Don't use kill-this-buffer to kill notmuch emacs buffers

kill-this-buffer appears to be a function intended specifically for
use in the menu bar, and causes problem killing notmuch buffers when
multiple frames have been used.  This patch replaces kill-this-buffer
with notmuch-kill-this-buffer, which in turn just simply calls
(kill-buffer (current-buffer)).

emacs: Fix notmuch-show-pipe-message to use notmuch-command variable

Previously notmuch command name was hardcoded into this function,
which made remote use of pipe command impossible.

NEWS: Update NEWS files for a couple of recent changes.

These two changes since the 0.4 release are noteworthy.

test: Add test for viewing raw message within emacs.

This provides further coverage for the recently added (and recently
modified) use of "notmuch show --format=raw" within emacs.

Rename "notmuch cat" to "notmuch show --format=raw"

This is part of an effort to avoid proliferation of excessive
top-level notmuch commands. Also, "raw" better captures the
functionality here, (as opposed to "cat" which is a fairly oblique
reference to a bad Unix abbreviation whose metaphor doesn't work here
since "notmuch cat" operates only on a single message and hence cannot
"con'cat'enate" anything).

test: Add test for saving an attachment from emacs

This tests the use of "notmuch cat" recently added to the emacs
interface.

emacs: Access raw messages via cat subcommand

This patch modifies the following commands to access the messages via
cat subcommand:
- view/save attachments ('v', 'w'),
- view a raw message ('V') and
- pipe a message to a command ('|').

With this patch, it is straightforward to use notmuch emacs interface
with a remote database accessed over SSH. To do this, it is sufficient
to redefine notmuch-command variable to contain the name of a script
containing:

    ssh user@host notmuch "$@"

If the ssh client has enabled connection sharing (ControlMaster option
in OpenSSH), the emacs interface is almost as responsive as when
notmuch is invoked locally.

Add 'cat' subcommand

This command outputs a raw message matched by search term to the
standard output. It allows MUAs to access the messages for piping,
attachment manipulation, etc. by running notmuch cat rather then
directly access the file. This will simplify the MUAs when they need
to operate on a remote database.

Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace,
add missing "test_done" to new test script to avoid "Unexpected exit"
error.

Makefile: Support "make check" as alias for "make test"

I'm told that some people have been trained by autotools to expect
this target name.

test: Don't mess with user's HOME directory

This was too rude of a thing to do and could easily introduce
problems, (as reported by Rob Browning whose environment required some
HOME-specific things for shell startup).

Instead, implement more focused changes to ensure that particular file
in $HOME don't cause problems. Specifically, we fix known problems
with ~/.signature and ~/.mailrc here.

test: Update mail corpus with original mails (with attachments).

The original mails used to pupulate the mail corpus had had their
attachments (obnoxiously) scrubbed by the pipermail mail archiver.
Since we actually want to test the handling of attachments, this is
less than useful. Restore these files from my own collection, (with
some Received and similar headers pruned).

test: Clear the "BROKEN" flag on an existing emacs test

I still don't know everything about how I want search order to be
customizable, but I do like the current defaults, (namely, performing
a new search gives results newest first, but performing a saved search
like "tag:inbox" gives results as oldest first).

Until we come up with a better plan for people to select what *they*
want, (rather than just getting what I want), let's codify the current
results in the test suite.

test: Generate a little run_emacs script to help debug any failures.

After any emacs test failure, the tmp.emacs directory will have this
run_emacs script in it which the user can use to run emacs within the
test suite environment, (pointing at the test suite's notmuch
database, using the local notmuch command-line program, and the local
notmuch emacs lisp code).

TODO: Add idea for notmuch-bcc and notmuch-cc variables.

To more easily support those folks that want to Bcc with every
message.

Print nothing when search result is empty

This change affects both text and json formats. Now, text format
behaves as before commit 6dcb7592, but json format is changed.
Earlier, the empty search returned '[]', now it returns ''. The emacs
interface seems not to be affected by this change.

test: Search for non-existent message should return nothing

My scripts expect that empty search result is actually empty. Since
commit 6dcb7592, even empty search prints a newline character and this
breaks my scripts.

This patch adds a test for this bug. In the test I cannot use
test_expect_equal function as $() operator suppresses the final
newline and this kind of difference is not detected.

 test/search |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

debian: Add a file stating the intended symbols to appear in the library

This is almost totally clearn. The (mangled) names of the Xapian
exception classes appear here. That's not actually desired, as the
notmuch library is never intended to throw any exceptions. But Xapian
does not currently provide a mechanism for us to avoid these.

Makefile: Move the -Wl,-as-needed option earlier in the command line.

This option wasn't having the desired effect, and sure enough, the
documentation states that it only affects the linking of libraries
that appear after this option on the command line. So put it early for
the desired effect.

lib: Eliminate some redundant includes of xapian.h

Most files including this already include database-private.h which
includes xapian.h already.

lib: Add GCC visibility(hidden) pragmas to private header files.

This prevents any of the private functions from being leaked out
through the library interface (at least when compiling with a
recent-enough gcc to support the visibility pragma).

lib: Add some missing static qualifiers.

These various functions and data are all used only locally, so should
be marked static. Ensuring we get these right will avoid us accidentally
leaking unintended symbols through the library interface.

debian: Use the correct maintainer address for the package upload.

Otherwise, Debian tools think this is an NMU.

debian: Declare conformance with Standard-Version 3.9.1.0

I ran through the upgrading-checklist and found nothing needing to be
changed for this package.

Makefile: Build library with -Wl,--as-needed

Previously, we were building the final binary with this option, but not
the library. The library can benefit from it as well, (as pointed out
by Debian's lintian).

manpage: Add escaping for hyphen used as minus

As pointed out by Debian lintian, options with '-' might not be
copy/pastable if formatted with an unescaped '-' character.

debian: Add changelog entry for the 0.4 release.

Which is just about to be made.

Increment notmuch version to 0.4.

As reminded in the RELEASING instructions, the correct version is 0.4,
not 0.4.0, so update this in the NEWS file as well.

Update library version to 1.2.0

This increment is for the recently-added functions:

notmuch_query_get_query_string
notmuch_query_get_sort

These were recently added to the library interface, but the library
version was not incremented at that time, (shame on me).

NEWS: Add notes for the 0.4.0 release

Which is about to be pushed out.

configure: Add a check for the -Wl,--as-needed flag.

This fits with our general build philosophy of checking at configure
time for desired support, (rather than putting platform-specific
conditionals into our Makefiles).

fixup

build: only link to what we really use

At least linux has the -Wl,--as-needed option.

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

configure: Remove a debugging print message.

This was never intended to be committed.

configure: Test for flag to set rpath

This is better than the previous approach which had a hardcoded Linux-specific
value in the Makefile.

configure: Test for each compiler warning before enabling it.

This should allow the build to be much more automatically portable
to compilers with different sets of warning options.

test: Test emacs notmuch-hello with no saved searches to display.

Haippily, this works just fine, but we might as well test that.

test: Test emacs notmuch-hello when displaying a saved search with 0 results.

This test verifies that the bug fix in the previous commit is working.

Fix problem with notmuch-hello-nice-number

Without this little patch notmuch fails if asked to display a saved
search that has zero results

Edited-by: David Edmondson <dme@dme.org>: With code that is a little
more "emacsy".

emacs: Re-work the implementation of highlighting in notmuch-search-mode.

Re-write `notmuch-search-color-line', with the following improvements:
 - create overlays only if they will be needed,
 - merge the properties specified for a tag on top of any matching a
   previous tag.

debian: Add emacs autoloads for all top-level notmuch functions.

With this, users will be able to simply "apt-get install emacs" and
then "emacs -f notmuch" without having to edit ~/.emacs to add a
("require 'notmuch)".

emacs: Fix the autoload comments

Remove them from non-top-level entry points, (such as the functions to
set notmuch modes and the deprecated notmuch-folder function). And add
one to the notmuch-hello function. Also, add missing documentation
string to notmuch-hello.