Makefiles: Eliminate shell for loops in rule definitions.

These just made the output look so ugly, and weren't actually making
the rule definitions any simpler. Good riddance.

Move installation of library from top-level to lib/Makefile.local

We had a fairly ugly violation of modularity with the top-level
Makefile.local isntalling everything, (even when the build commands
for the library were down in lib/Makefile.local).

Makefile.config: Avoid pre-expanding the ${prefix} variable.

One of the supproted mechanisms we offer for configuration is
manually editing the Makefile.config file after it is generated
by the configure script. In this case it would be nice to be able
to change prefix only once, so allow that.

Move some variable assignments from Makefile.local to Makefile.config

There's not any special configure logic for determining these variable
values, but if we did add some in the future, then these will now be
in the right place for that.

Additionally, this now makes Makefile.local the single place for the
user to look for manually tweaking a variable assignment, (say, for a
compiler that can't accept a particular warning argument).

With this change, there should rarely be any need for a user to poke
into any Makefile.local file.

Move bulk of rules from Makefile to Makefile.local.

Before it was impossible to know whether any particular setting or
rule definition was in Makefile or Makefile.local. So we strip the
Makefile down to little more than the list of sub-directories and
the logic to include all of the sub-directories' Makefile.local
fragments.

Then, all of the real work can happen inside of Makefile.local.

configure: Fix installation of library to work with alternate --prefix

If an explicit --libdir is passed, then that is used directly. Otherwise
libdir is chosen as the value of $PREFIX/lib, (whether or not prefix was
passed explicitly or set by default).

configure: Fix typo in help message.

Documentation is installed to PREFIX/man not PREFIX/share.

Add a --libdir option to ./configure

This allows packagers to specify to which directory libraries should be
installed.

Signed-off-by: Ingmar Vanhassel <ingmar@exherbo.org>

Fix target dependencies for multiple jobs

Signed-off-by: Ingmar Vanhassel <ingmar@exherbo.org>

Build and link against notmuch shared library, install notmuch.h

Signed-off-by: Ingmar Vanhassel <ingmar@exherbo.org>

emacs: Fix the notmuch-search-authors-width variable.

This variable existed previously, but wasn't actually used for anything.

Clarify documentation of notmuch_database_add_message.

For the case of adding a file that already exist, (with the same
filename). In this case, nothing will happen to the database, but
that wasn't clear before.

TODO: Note that '=' should sometimes count from the end of the buffer.

When trying to restore the current position, if the "current" thread
no longer appears in the buffer, then '=' moves to the current line
instead. When near the end of the buffer, the "current" line should
be counted as the number of lines from the end.

TODO: Add a todo item for adding a message as a blob, rather than a filename.

This was suggested by Srinivasa and is intended to make it easier to
integrate notmuch into an mbox-loving mail client.

TODO: Add some new items about improving the test suite.

I just tried (and failed) to write a test for the recent magic
inference of phrase searches. That's a feature that makes me *really*
uncomfortable to not have an automated test. But I believe the
proposed modularization of the test suite should reduce some quoting
nightmares, so will hopefully make this easier.

test: Fix phrase-search tests.

With some extra qutotation marks, we are now doing actual phrase
searches so these tests pass.

test: Add some negative results for the phrase searches.

These results have all the same terms as the target phrase, but
not in the expected order. They are designed to ensure that we
actually test phrase searches.

And as it turns out, we're not currently quoting the search terms
properly, so the phrase-search tests now fail with this commit.

notmuch-show: add tags to json output

The previous json patches forgot to add the notmuch tags to the json
output. This is inconsistent to the text output so here they are. We
just output a 'tags' field that sends notmuch tags as a json array.

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

emacs: Fix search refresh when on the last line of a search buffer.

We currently allow the cursor to be positioned on the "End of search
results" line after the last thread in a search buffer. When
refreshing on this line, there's no thread ID to be used as the
target.

Previously, a refresh from this case would result in a nil thread
target, but we were also using nil to indicate that the target thread
had been found. This caused the position to be lost during refresh,
(the cursor would move from the last line in the buffer to the first).

We fix this by using a magic string of "found" rather than nil to
clearly indicate whether the target thread has actually been found.

emacs: Adjust search refresh to use a target line not a target position.

It doesn't make sense to move the cursor to some random point in the
middle of a line. We always want the refresh to leave the cursor at
the beginning of some line instead.

Makefile: Fix Makefiles to depend on all child Makefile fragments.

We were previously maintaining two lists of the child Makefile
fragments---one for the includes and another for the dependencies. So,
of course, they drifted and the dependency list wasn't up to date.

We fix this by adding a single subdirs variable, and then using GNU
Makefile substitution to generate both the include and the dependency
lists.

Some side effect of this change caused the '=' assignment of the dir
variable to not work anymore. I'm not sure why that is, but using ':='
makes sense here and fixes the problem.

Makefile: Use 'emacs --quick' for a less noisy build of "make install-emacs".

I don't really notice if it goes any quicker, but it's sure nice to have
less spew now.

Makefile: Add a message after "make install-emacs"

More help to guide the new user here. Tell the user how to actually
invoke the emacs client now that it's installed.

Makefile: Conditionalize the "make install" message.

This is the same approach as with the 'all' target previously.

Makefile: Simplify the conditional message of the all target.

We wamt a simple "make" to call the 'all' target and then print a
message when done, but we don't want "make install" which depends on
that same 'all' target to print the message.

We previously did this with a separate 'all-without-message' target,
which was inelegant because it caused all users of the target to
carefully depend on 'all-without-message' rather than 'all'.

Instead, we now use a single 'all' target but with a Makefile
conditional that examines the MAKECMDGOALS variable to determine
whether to print the message.

Makefile: Add message to make install listing the other install targets.

Otherwise, it's hard for the user to know that things like install-emacs,
install-bash, and install-zsh even exist.

Makefile: Add a meesage after "make" telling the user to run "make install"

As one command completes, it's kind of the tool to indicate which
command the user should execute next.

Makefile: Rename all_deps to global_deps

The "all" inside this variable name was easy to confuse with the
separate "all" target. This variable specifies dependencies that apply
to every target, so use "global" instead.

Add is:<tag> as a synonym for tag:<tag> in search terms.

I like the readability of this, it provides compatibility with people
trained in this syntax by sup, and it even saves one character.

emacs: Move emacs UI (currently just one file) to subdirectory.

Add emacs/Makefile.local and emacs/Makefile. Move emacs targets into
emacs/Makefile.local, but leave the byte compilation rule in the top
level Makefile.

INSTALL: Include Fedora command for installing dependencies of notmuch.

We already had this command in the error message from the configure script,
so we should include it here as well.

INSTALL: Add a pointer to ./configure --help

We have some good documentation in ./configure --help, so we should
direct users to it.

lib: Silence a compiler warning.

The original code was harmless, but apparently some compilers aren't
able to think deep enough to catch that.

emacs: Fix refresh of search results to leave cursor on current thread.

This has been broken since the addition of support for streaming
search results to the emacs interface. With the old apparoach it was
easy to simply wait for all search results to land in the buffer and
then search for the desired line. With streaming results, we have to
save the target off to the side and allow the process filter and
sentinel functions to correctly respond when the target thread
appears.

Fix a few documentation typos in notmuch.h

Fix a few documentation typos in notmuch.h

Signed-off-by: Fernando Carrijo <fcarrijo@yahoo.com.br>

Update documentation of notmuch_query_create

Commit cd467caf renamed notmuch_query_search to notmuch_query_search_messages.
Commit 1ba3d46f created notmuch_query_search_threads. We better keep the docs
of notmuch_query_create consistent with those changes.

Signed-off-by: Fernando Carrijo <fcarrijo@yahoo.com.br>
Edited-by: Carl Worth to explicitly list the full name of each
function being referenced.

notmuch show: Don't show empty headers.

This is a fairly old regression. There has always been code to avoid
printing empty headers (such as Cc or Bcc with no values), but it has
been broken since notmuch_message_get_header was changed to return
an empty string rather than a NULL pointer for these fields.

TODO: Add proposal for a saved-search interface.

Adding this to our TODO list so that it doesn't get forgotten.

TODO: Remove many items that have been completed recently.

There's been a lot of good work done, and we've been doing a generally
poor job of noticing when some of the tasks we've completed were
already on our TODO list.

So here's a careful scan, removing all items I could find that have
already been done.

emacs: Fix documentation of notmuch-search-remove-tag.

The behavior was changed in commit 4aff2ca55bfe285ced36e9fe02c907d8b4120672
to affect all messages in the thread (and not only those matching
the current search) but the documentation was not updated (until
now).

lib: Document what move_to_next does at the end of the list.

Explicitly mention that there's an invalid position after the last
item in the list.

lib: Rename iterator functions to prepare for reverse iteration.

We rename 'has_more' to 'valid' so that it can function whether
iterating in a forward or reverse direction. We also rename
'advance' to 'move_to_next' to setup parallel naming with
the proposed functions 'move_to_first', 'move_to_last', and
'move_to_previous'.

emacs: Fix backspace to not scroll more than the previous message

The bug was occuring due to counting invisible lines, but then
scrolling past them since they are invisible.

emacs:  Unbreak notmuch-show-rewind (the function to which Backspace is bound)

Commit 095a02211e696434e5b41a85ab516b3a639f9a9b broke the backspace
key by trying to execute nil as a function, (which obviously won't
work), when it was intended as a return value. Fix this now, (and pine
for a test suite that exercises the emacs user-interface of notmuch).

emacs: Make 'n' and 'p' navigate only open messages.

And add new 'N' and 'P' keybindings for navigating through messages
that are open or closed.

emacs: Don't open unread messages by default.

When searching for an individual message, (by message id, say), it's
really annoying to have the entire thread open just because the thread
was archived without ever having been read.

This means that the "unread" tag is a lot less special, and it really
just exists as a mild cue for the user.

README: Mention that notmuch only supports maildir or mh format.

Justin B Rye pointed out (in Debian bug #566282) that a user with mail
in mbox format can spend a lot of time investigating notmuch before
realizing that mbox is not supported. Head that off with a more
detailed mention in the README blurb.

emacs: Avoid removing the unread tag due to internal navigation

Sometimes the internals of the implementation navigate among messages,
(as opposed to the user explicitly requesting the next message to be
shown). In these cases we don't want to remove the unread tag from the
message navigated to.

This fixes a bug where invocation of notmuch-show-next-unread-message
would clear the unread tag from all messages in a thread.

Simplify "unread" tag handling in emacs UI.

This patch is intended to greatly simplify the handling of the
"unread" tag in the emacs UI.  This patch adds a new function
'notmuch-show-mark-read', that removes the "unread" tag in
notmuch-show-mode.  This function is then executed as a
notmuch-show-hook, and by notmuch-show-next-message.  All of the
functions that explicitly marked messages as unread are removed or
renamed.

The idea here is that the user should never have to worry about
manipulating the "unread" tag.  The tag should persist until the user
actually views a message, at which point it should be automatically
removed.  This patch simplifies the notmuch.el quite a bit, removing a
lot of somewhat redundant functions, and reducing clutter in the name
and key-mapping space.

TODO: We should fix the --format=json option to not imply --entire-thread.

What we print and how we print it are orthogonal options, so --format
shouldn't change what messages are printed.

notmuch search: Use "thread" rather than "id" when formatting with JSON

The text output uses thread:<foo>, (which is a syntax directly supported
by "notmuch show"), so make the json output be "thread", "<foo>" rather
than "id", "<foo>". This should help avoid confusion of thread IDs with
message IDs, (which do use the "id" prefix in searches).

json: Add copy of MIT license text from cJSON

When we incorporate external code, we should include its license,
(particularly when one of the terms of the license is to include it in
copies).

Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show.

In the case of notmuch-show, "--format=json" also implies
"--entire-thread" as the thread structure is implicit in the emitted
document tree.

As a coincidence to the implementation, multipart message ID numbers are
now incremented with each part printed. This changes the previous
semantics, which were unclear and not necessary related to the actual
ordering of the message parts.

TODO: Rename the proposed --for option to --output

We've been using --output in IRC and on the mailing list for a while,
(someone had the good sense to point out that --for would defeat
command-line completion since it's a prefix of the proposed --format).

notmuch.1: Use bold and indentation for the NOTMUCH_CONFIG variable.

This seems to be the standard method of formatting an environment
variable section within a man page.

Add ENVIRONMENT VARIABLES section to the man page

Briefly describe the NOTMUCH_CONFIG variable there.

notmuch.el: Emphasize the 'i' of 'ID' in the documentation for 'c i'.

We're using 'i' in the keybinding, so it helps to have a capital
'I' in the help string to empahsize the point.

Change the stash keybinding from 'z' to 'c'. And use 'i' for message ID.

In spite of being implemented with the word "stash" in the function
names, the documentation (and hence help strings) for each function
already use the word "Copy" to describe the action. So 'c' is a much
more natural key-binding, (particularly since 'z' didn't map to any
real word anyway).

We also use 'i' for the message ID copying of the submap. This is
intended to align mnemonically with the "id:" prefix already used
for message IDs.

notmuch.el: add a submap (on "z" for "ztash") to stash things.

Provide key bindings for stuffing various RFC822 header fields and other metadata
into the emacs kill-ring as text. The bindings are as follows:

z F notmuch-show-stash-filename
z T notmuch-show-stash-tags
z c notmuch-show-stash-cc
z d notmuch-show-stash-date
z f notmuch-show-stash-from
z m notmuch-show-stash-message-id
z s notmuch-show-stash-subject
z t notmuch-show-stash-to

notmuch.el: convert sparse keymap to a list in notmuch-substitute-one-command-key-with-prefix

The previous version would crash when a key was bound to a sparse
keymap, since apparently these are not straightforward lists.  The
usage of map-keymap is a bit obscure: it only has side-effects, no
return value.

Add functions notmuch-show-get-(bcc, cc, date, from, subject, to).

Return the corresponding header field for the current message as a
string.  These are thin wrappers around notmuch-show-get-header, which
means they each cause a full parse of the RFC822 header. The main idea
is to fix an api.

notmuch-show-get-header: new function; return alist of parsed header fields.

This function parses the displayed message to recover header
fields. It uses mailheader.el to do the actual header parsing, after
preprocessing to remove indentation.  It relies on the variables
notmuch-show-message-begin-regexp, notmuch-show-header-begin-regexp,
and notmuch-show-message-end-regexp.

notmuch.el: Delete some trailing whitespace.

I'm not sure when this managed to creep in, but we don't want it.

notmuch.el: Fix bug from message with ':' in the From address.

Eric reported that a particular thread was non-functional in the
notmuch-search mode in the emacs client. It was easy enough to trace
the bug down to a broken regular expression (using ':' instead of
';'). The bug would be triggered by a message with ':' in the
From address.

This is something I hope to add to the test suite as soon as we have
support for testing the emacs interface there.

notmuch.el: Handle attached images via an external viewer.

We temporarily override the mm-inline-media-tests variable so that the
only parts inserted into the temporary buffer (and lost) are those
parts that the user has already seen in the notmuch-show buffer.

Anything else, (such as images), will now be left to be handled via
mailcap, just like other attachment types.

notmuch.el: Fix indentation.

This line was indented incorrectly which can be confusing.

notmuch.el: Avoid infinite loop marking up message with no parts.

The infinite loop was triggered by a message consisting of a single
attachment within the body, (and no "part") tags.

We need to do things in response to this bug (beyond this specific
fix):

1. Create a test suite that exercises our emacs frontend so that bugs
   like this do not come back to haunt us after we fix them once.

2. Switch from our ad-hoc regexp based search of message-part delimeters
   to known-good code for parsing a structured document, (for example,
   the outstanding JSON patches).

Reintroduce HTML inlining, with a much needed optimization

Now instead of requiring every single message be parsed, we now check
the Content-type in the parsed headers and only do HTML inlining if it's
text/html

Fix printf for when uint64_t != unsigned long long int

Thanks to Michal Sojka <sojkam1@fel.cvut.cz> for pointing out the
correct fix, which I verified in the freely-available WG14/N1124 draft
(from the C99 working group) which is available here:

http://www.open-std.org/JTC1/SC22/wg14/www/docs/n1124.pdf

Switch from random to sequential thread identifiers.

The sequential identifiers have the advantage of being guaranteed to
be unique (until we overflow a 64-bit unsigned integer), and also take
up half as much space in the "notmuch search" output (16 columns
rather than 32).

This change also has the side effect of fixing a bug where notmuch
could block on /dev/random at startup (waiting for some entropy to
appear). This bug was hit hard by the test suite, (which could easily
exhaust the available entropy on common systems---resulting in large
delays of the test suite).

TODO: Add some recently discussed items.

These were collected either from the mailing list of from IRC
conversations. The good ideas probably aren't mine, and the mistakes
probably are.

Allow folders with no messages to be elided from list

This makes it easier to see folders with messages.
Eliding empty folders is togged with the 'e' binding.

Signed-off-by: Keith Packard <keithp@keithp.com>

Look at whitespace to separate folder name from count

This allows folder names to contain any non-blank characters

Signed-off-by: Keith Packard <keithp@keithp.com>

Add 'm' and ' ' bindings to notmuch-folder view

This allows the user to compose new mail from the folder view, and
also to use <space> to show the current folder.

Signed-off-by: Keith Packard <keithp@keithp.com>

emacs: Use font-lock-comment-face to highlight citation button

Signed-off-by: Kan-Ru Chen <kanru@kanru.info>

notmuch.el: show some of citation even when hiding.

- rename notmuch-show-citation-lines-min to n-s-c-l-prefix
- call forward-line with the appropriate parameter to adjust
  region to be hidden.
- change citation button text so that it makes (some) sense when citation is shown

Reviewed-by: Kan-Ru Chen <kanru@kanru.info>

notmuch.el: Refactor citation markup. Variables for minimum size, button text.

This is a fairly intrusive rewrite.

- I pulled the common code for the signature and citation case out
  into a separate function. This is not so much shorter, but I think it
  will be easier to maintain.

- I replaced the sequence of (looking-at blah) (forward-line)  with a single
  re-search-forward per citation.

New variables

- notmuch-show-signature-button-format, notmuch-show-citation-button-format
  Allow customization of button text.

- notmuch-show-citation-lines-min
  Do not buttonize citations below the given threshold.

Reviewed-by: Kan-Ru Chen <kanru@kanru.info>

notmuch.h: Fix a couple of typos in the documentation.

Obviously, the spell-checker isn't able to catch every mistake
I make.

notmuch restore: Don't waste time with messages with unchanged tags.

It's a simple optimization to look at a message and check that the
existing tags are actually different than the tags we are setting
before we do anything.

For my mail store this takes a "notmuch restore" that does nothing
from about 10 minutes down to 1 minute, so there's a significant
speedup here.

notmuch-test: Add basic tests for "notmuch dump" and "notmuch restore"

Our test-suite coverage keeps improving, (slowly).

notmuch-test: Fix misalignment in output.

Clean output is just so much easier to read (and validate).

notmuch.el: Use emacs built-in forward-button and backward-button

There are built-ins, so why not use them?

Signed-off-by: Kan-Ru Chen <kanru@kanru.info>

Use forward-line instead of next-line

We do this all the time, but at least emacs is kind enough to remind us,
(when compiling), that next-line is only intended for interactive use,
and we should use forward-line inside of lisp code.

notmuch.el: Add missing documentation for the new 'h' keybinding.

Without this, our help screen displayed 'h' with no description of
what it does.

notmuch.el: Add keybinding to toggle display of message body and headers.

I really missed this feature. Added notmuch-show-toggle-current-body and
notmuch-show-toggle-current-header and bind them to 'b' and 'h'.

Signed-off-by: Kan-Ru Chen <kanru@kanru.info>

notmuch-test: Add test to verify that uuencoded data is not indexed.

As recently promised, no new features are being accepted to notmuch
without corresponding new tests for the test suite.

notmuch-test: Add several tests of "notmuch search"

These tests were surprisingly simple to write---not much code at all
and most of them worked the first time even with hand-prepared
versions of the expected output.

notmuch-test: Add a new add_message function.

The previous generate_message function is what's needed when testing
"notmuch new". But after that, we never want to generate a message
without also adding it to the index. So create a new add_message
function with this convenience.

Eliminate some useless gobject boilerplate.

If we had external users of this filter then they might expect some of
these macros to exist. But since this is just internal, that's just
unneeded noise.

notmuch new: Don't index uuencoded data.

With modern MIME attachments, we're already avoiding indexing the
attachments. But for old-school uuencoded data in the mail, we have
been directly indexing the encoded data as terms, (which is not useful
at all---nobody will ever ytry to search based on the seemingly random
uuencoded data).

Additionally, indexing a modestly large uuencoded file seems to make
Xapian go insane, (consuming *lots* of memory).

We fix both problems by detecting uuencoded content and not performing
any indexing of it.

notmuch reply: Rename the mailing_list_munged_reply_to function

This function detects whether the address in the Reply-To header
already appears in either To or Cc. So give it a name that reflects
what it does (reply_to_header_is_redundant) rather than the old name
which described one possible use of the function, (as a simple
heuristic for detecting whether a mailing list had applied reply-to
munging).

notmuch reply: Prevent GMIME assertion complaints for empty Reply-to header.

Apparently, GMime doesn't want to create a valid address list object
for an empty string. That's annoying, but it's easy enough to test for
the empty string and avoid the problem.

notmuch reply: Use strstr instead of strcasestr for portability.

This change was already recommended in a comment in the original
implementation of this patch. If someone really wants to support
un-munging in the case of To: and Reply-To: having the same address
but different case, then they can provide a portable approach for
that.

notmuch reply: Fix the support for reply-to un-munging.

The condition was using a reversed sense for the test of the return
value of strcasestr, (perhaps confusing it with the usage of strcmp?).

notmuch-reply: Add missing whitespace.

Some recently-added functions were to hard for me to read without
the expected whitespace. Fix these.

notmuch-test: Test "notmuch reply" with a reply-to-munged mail

This is a test for the recently added feature where we detect that the
reply-to address already exists in the To: or Cc: header so will
already be replied to. In this case we want to include the From:
address in our reply, (where, otherwise we would use the Reply-To
address *instead* of the address in the From header).

notmuch-reply.c: Handle munged `Reply-To' headers.

Some mailing lists engage in the evil practice of changing the Reply-To
header so that replies from all mailers go to the list by default, at
the expense of not responding to the person who actually sent the
message.  When this is detected, we reply to `From' and remove the
duplicate response to the mailing list.  Consider a reply to the
following message.

  From: Some User <some.user@example.com>
  To: Sample users list <sample-users@sample.org>
Reply-To: Sample users list <sample-users@sample.org>
Prior to this patch, `notmuch reply' produces

  To: Sample users list <sample-users@sample.org>,
      Sample users list <sample-users@sample.org>

and after the patch,

  To: Some User <some.user@example.com>,
      Sample users list <sample-users@sample.org>

Signed-off-by: Jed Brown <jed@59A2.org>

notmuch-reply.c: Factor adding recipients into common function

This code was already duplicated. We move it to a new, shared
add_recipients_from_message function, in preparation for more
sophisticated mailing list logic.

Signed-off-by: Jed Brown <jed@59A2.org>

notmuch-test: Test "notmuch reply" with multiple recipients

The feature tested here is that we reply to both the sender and to
others addresses on the To: line of the original message, but that we
don't reply to our own address.

notmuch-test: Add test for "notmuch reply" with a CC header.

A simple test to help round out the set of tested features.