notmuch setup: Add some comments when creating a .notmuch-config file.

The "notmuch setup" command is nice and all, but we also want to allow
users to conveniently edit the configuration file directly.

notmuch: Add a configuration system.

This will allow for things like the database path to be specified
without any cheesy NOTMUCH_BASE environment variable. It also will
allow "notmuch reply" to recognize the user's email address when
constructing a reply in order to do the right thing, (that is, to use
the user's address to which mail was sent as From:, and not to reply
to the user's own addresses).

With this change, the "notmuch setup" command is now strictly for
changing the configuration of notmuch. It no longer creates the
database, but instead instructs the user to call "notmuch new" to do
that.

notmuch setup: Break the implementation up into manageable functions.

The notmuch_setup_command function was getting entirely unwieldy.
Break it up into smaller functions for better maintainability.

notmuch reply: Use GMime to construct the header for the reply.

The advantage here is that we actually get the necessary folding of
long headers, (particularly the References header, but also things
like Subject). This also gives us parsed recipient addresses so that
we can easily elide the sender's address(es) from the recipient list
(just as soon as we have a configured value for the recipient's
address(es)).

notmuch.el: Add a binding ('r') to reply to the current message.

We were just starting to get "notmuch reply" into shape in order to
provide the needed functionality here, but then I realized that the
message-reply function built into emacs is already more functional,
(at least for the case of replying to a single message).

notmuch reply: Process headers a bit more accurately.

We know take the original From: and all recipients and put them on the
To: line. We also add a "Re: " to the subject, and we add In-Reply-To:
and References: headers.

notmuch.el: Simplify get-message-id

We were stripping off the "id:" portion of the identifier, only to
put it back on again in all cases. Stop this madness.

notmuch reply: Add (incomplete) reply command

Reviewed-by: Carl Worth <cworth@cworth.org>
Keith wrote all the code here against notmuch before notmuch.c was
split up into multiple files. So I've pushed the code around in
various ways to match the new code structure, but have generally tried
to avoid making any changes to the behavior of the code.

I did fix one bug---a missing call to g_mime_stream_file_set_owner in
show_part which would cause "notmuch show" to go off into the weeds
when trying to show multiple messages, (since the first stream would
fclose stdout).

notmuch: Break notmuch.c up into several smaller files.

Now that the client sources are alone here in their own directory,
(with all the library sources down inside the lib directory), we can
break the client up into multiple files without mixing the files up.
The hope is that these smaller files will be easier to manage and
maintain.

.gitignore: Ignore .deps directory.

We recently moved dependencies from a single .depends file to a directory
named .deps with many files, but neglected to update our .gitignore rules.

Makefile: Change default flags to -O2.

We've now verified that it's reliable for the user to override CFLAGS
on the command line, so just make the user do to get a debug build.

Makefile: Make the top-level Makefile a little more independent.

Previously, the top-level Makefile was explicitly adding -I./lib to
the compiler flags. However, that's something that's much better done
from within the Makefile.local fragment within the lib directory
itself.

Makefile: Simplify setting of CFLAGS, etc.

We were previously using separate CFLAGS and NOTMUCH_CFLAGS variables
in an attempt to allow the user to specify CFLAGS on the command-line.

However, that's just a lot of extra noise in the Makefile when we can
instead let the user specify what is desired for CFLAGS and then use
an override to append the things we require. So our Makefile is much
neater now.

Makefile: Fix dependency generation to make .d files themselves dependent.

I saw this recommendation in the implementation notes for "Recursive
Make Considered Harmful" and then the further recommendation for
implementing the idea in the GNU make manual.

The idea is that if any of the files change then we need to regenerate
the dependency file before we regenerate any targets.

The approach from the GNU make manual is simpler in that it just uses
a sed script to fix up the output of an extra invocation of the
compiler, (as opposed to the approach in the implementation notes from
the paper's author which use a wrapper script for the compiler that's
always invoked rather than the compiler itself).

Implement a non-recursive make.

The idea here is that every Makefile at each lower level will be an
identical, tiny file that simply defers to a top-level make.

Meanwhile, the Makefile.local file at each level is a Makefile snippet
to be included at the top-level into a large, flat Makefile. As such,
it needs to define its rules with the entire relative directory to
each file, (typically in $(dir)). The local files can also append to
variables such as SRCS and CLEAN for files to be analyzed for
dependencies and to be cleaned.

Makefile: Hide away auto-generated dependency file as .depends.

Instead of the old name of Makefile.dep. The idea being that the
user really doesn't need to see this by default, (and if debugging
the Makefile, the rules will make the name obvious).

Remove obsolete message.h.

This has been around but never used, and only became apparent now
that the other sources moved down into the lib sub-directory.

libify: Move library sources down into lib directory.

A "make" invocation still works from the top-level, but not from
down inside the lib directory yet.

notmuch.el: Don't advance line in search buffer before showing thread.

Previously, when selecting a thread to view from the search buffer, we
would advance the point by one line before showing the thread, (so
that it would be ready to show the next thread once the user was done
with the current thread). This was annoying when the user temporarily
exited the thread view, (because the "wrong" thread was then selected
in the search view).

We get a more consistent experience by waiting to advance until the
user has finished viewing one thread and is ready to view the next.

notmuch.el: Fix add/remove tag from search buffers.

These were recently broken with the change of "notmuch search" to
prefix thread IDs with "thread:" rather than printing them raw.

add_message: Fix crash for file recognized as not email.

This crash was introduced sometime recently, as previously things
worked fine when notmuch detected that a file is not an email.
We're definitely overdue for that test suite.

TODO: Note that notmuch restore needs some progress indication.

A recent "notmuch restore" command took *forever* for me. Obviously,
we need to fix the underlying performance bug in Xapian, but in the
meantime, a progress indicator would help.

notmuch setup: Remove a debugging print.

This was just some extra noise printed when requesting a non-default
mail directory itneractively.

add_message: Start storing In-Reply-To information in the database.

We'll use this eventually for properly nesting messages in the output
of "notmuch show", etc.

Makefile: Fix install target to depend on the all target.

Otherwise, it would just fail if you hadn't run "make" already.

notmuch show: Don't show the subject line twice.

I recently added a print of the subject line for use as part of a
two-line summary in the emacs client. But of course, the subject was
already being printed on the next line. So I didn't really need to add
anything, I could have just stopped hiding what was already
printed. Anyway, we now avoid printing it twice in a row.

add_message: Fix segfault for message with no Date header.

I'd fixed this earlier when I had a private copy of GMime's
date-parsing code, but I lost the fix when I recently switched to
calling the GMime function.

notmuch show: Move subject from one-line summary down to its own line.

And change the display code in emacs to display the one-line summary
in inverse video.

notmuch.el: Bring back the "End of search results." message.

The recent change of the hidden thread-ID syntax caused this message
to instead be replaced with a cryptic "search failed" error and an
internal regular expression. Put our nice message back.

notmuch.el: Make hidden parts advertise how to unhide them.

This is in place now citations and signatures. We'll still need to
add something else for hidden messages (those that are already
read and hidden away).

notmuch.el: Add 'A' binding to archive thread after removing all "unread" tags.

This is useful for when the rest of the thread is visible on screen so
the user really has read the rest of it.

Update notmuch man page with recently-added documentation.

It would be nice to have this documentation live in a single place,
but for now, this is what we get.

notmuch search: Document the from, to, and subject prefixes.

I've been using these for a long time, but I had neglected to document
them until now.

notmuch show: Fix to work with any search string rather than just a thread ID.

The more general command is more consistent, and more useful.

We also fix "notmuch search" to output copy-and-pasteable search terms
for the thread with "thread:" prepended already. Similarly, the
message-ID in the output of "notmuch show" is also now printed as a
valid search term, ("id:<message-id>" rather than "ID: <message-id>").

Naturally, the emacs code is also changed to track these changes.

notmuch.el: Add 'N' binding to mark message read and go to next.

The magic space bar is nice, but sometimes there's a message with a
long attachment that I just want to skip, but still consider the
message marked as read.

notmuch.el: Don't require an extra press of space bar before archiving.

I had implemented this intentionally originally, thinking that it
would be important to see the last message scroll all the way off
screen before the next press of the magic space bar would go and
archive away the whole thread.

But in practice, that just turns out to be annoying, (especially for a
long sequence of single-message threads where the space bar has to be
pressed twice for every one). It's actually quite easy to know if it's
"safe" to press the space bar expecting just a scroll instead of an
archive by simply looking down and seeing if the current window is
full.

And as for the total lack of undo with all of this, I'm getting by by
simply using x to get back to the search view, and then going back
into the thread of interest.

notmuch.el: Add a simple command to pipe a message to a process.

With the obvious keybinding.

notmuch.el: Don't skip read messages when they are open.

More magic for the magic space bar: If a thread is entirely open,
(such as when viewing an old thread where every message is read), the
space bar now visits each message in turn (rather than skipping all of
the unread messages).

notmuch.el: Allow for scrolling backwards through thread with DEL

Otherwise known as "Backspace" on keyboards in the real, (rather than
emacs), world. This will go by screenfuls for long messages, and
message by message for short messages. So it does the reverse of the
magic space bar, (but without reversing any tag-changing magic that
the magic space bar might have done).

notmuch.el: Add 'w' binding to view raW email message.

This takes advantage of the new filename output just added to "notmuch
show".

notmuch show: Add filename to output (next to message ID).

This will allow a client using "notmuch show" to directly open the
filename and do whatever it wants with it.

notmuch.el: Don't use defvar for undocumented variables.

Make at least some attempt to distinguish internal variables from
those that the user is expected to fiddle with.

notmuch.el: Don't hide long signatures.

Chances are, a signature above a certain threshold isn't just a
signature, (for example, it could be an encrypted messages tacked onto
the end of the file, or could be any sort of PS.)

We add a new variable, notmuch-show-signature-lines-max that can be
used to configure the threshold, (set to 6 by default for now).

notmuch.el: Fix to claim correct number of lines for hidden signature.

Previously, it was reporting that all signatures were 0 lines.

notmuch.el: Don't hide message bodies when all messages are read.

Presumably the user is trying to view this thread for a reason, so
it's better to actually show *something* rather than just the summary
lines.

notmuch show: Fix misplaced g_object_unref leading to error message.

We were inadvertently calling g_object_unref on a wild pointer leading
to the following error message:

GLib-GObject-CRITICAL **: g_object_unref: assertion
`G_IS_OBJECT (object)' failed

Now, why glib doesn't abort on critical errors, I'll never understand.

notmuch.el: Make notmuch-search scroll commands move to first/last message.

If there's nothing to scroll but we're not yet on the first or last
message then move point to that message.

notmuch.el: Override next-line and previous-line to make them reliable.

I noticed that these functions would sometimes leave point on an
invisible character[*]. The problem would be that point would appear
to be on a particular message, but adding or removing a tag would
actually add/remove a tag from the *previous* message.

Fix the C-n and C-p keybindings at least to call the underlying
command and then advance to a visible character. We set this-command
in our overrides so that the temporary-goal-column feature still
works.

[*] The documentation says that command loop is supposed to move point
outside of any invisible region when a command exits. But apparently
not.

notmuch.el: Un-break the magic space bar to scroll a long, single message.

Clearly some recent code was very fragile, which I noticed in that the
space bar would no longer scroll a long message if it was the only
message in a thread.

This resulted in a lot of churn, but hopefully things are more robust
now, (for example by using new predicates like
notmuch-show-last-message-p rather than doing heuristics based on
(eobp) or (window-end)).

As usual, the presence of invisible characters complicates the task of
making this stuff robust.

notmuch.el: Fix to show *something* when all messages are already read.

With the recent change of showing the first unread message, we would
scroll down to the end of the buffer if all messages were already
read. This would confusingly show nothing visible in the window.

Instead, detect this case and move to the beginning of the buffer.

notmuch.el: Make magic space bar advance to next unread messages.

The magic of the space bar is all about unread messages, so there's no
reason for it to advance to messages that have already been read.

Similarly, we now remove any magic from (n)ext so that it simply
advances to the next message without marking anything read, (which
makes it symmetrical with (p)revious).

notmuch.el: Move to first unread message on notmuch-show.

This is important for when a new message is delivered to an existing
enormous thread.

notmuch.el: Make next-message move to end of buffer after last message.

We need an easier way to detect when we're done with the last message
so taking advantage of the end-of-buffer position helps here.

notmuch.el: Leave a blank line after last thread in search.

This allows for pleasant termination of the "show next thread" magic
in notmuch-show mode. Now, it will terminate and show the
notmuch-search results rather than continually displaying the last
thread over and over.

notmuch.el: Move "show next thread" from magic-space-bar to archive-thread

If I explicitly hit the 'a' key before reading the whole thread, I
still want to advance to the next thread in my search.

notmuch.el: More magic for magic space bar: Show next thread from search.

This is implemented by stashing away the parent notmuch-search buffer
into a variable within the notmuch-show buffer. Then, when magic space
bar triggers an archive of the current thread, it switches to the parent
search buffer and shows the next thread.

notmuch.el: notmuch-search: Advance to next line before showing thread.

The idea here is that after viewing the thread, when we come back to
this buffer we'll be all ready to view the next thread.

notmuch.el: Make archive-thread more efficient for already archived messages.

The approach here is to move the optimization from mark-read to the
more general remove-tag. Namely, don't call out to a "notmuch tag"
command to remove a tag that's not there already.

notmuch.el: Make the magic spacebar archive a thread in the end.

Next all it needs to do is kill the buffer and show the next thread.

notmuch.el: Start implementing the magic space bar.

Currently this will either advance by screenfuls, or to the next
message if it's already within a screenful, and will mark each message
read as it is left.

It doesn't yet complete the magic by archiving the messages nor by
advancing to the next thread in the search.

notmuch.el: Fix to hide citations in body of read messages.

Previously, unhinding a read message would still show all the citations
in that message without an explicit command to make them visible. Fix.

notmuch.el: Redefine behavior of notmuch-show-previous-message

Now, if the user has manually moved point to somewhere within a
message, executing the previous-message command onece will rewind
point only to the beginning of the current message. Previously this
would go back to the previous message, (which the user can now do
easily and naturally by simply executing the command one more time).

notmuch.el: Fix notmuch-snow-next-message when on the last message.

Before this just brought the current line to the top of the
window. Now it actually moves to the beginning of the current message.

This is built on a much more solid foundation now with a function to
move to the summary-line of the current message, and then moving from
there.

notmuch.el: Add more complete documentation to the major modes.

These now provide a summary of the most useful features/bindings
as well as a complete printout of the relevant mode maps to show
all available keybindings.

notmuch.el: Make archive-thread advance to next line.

This is the command in notmuch-search mode and it's cer convenient
for it to advance to the next line there. (It would be even more
convenient if it didn't also take forever, but as mentioned before
that's an issue we'll need to fix in Xapian.)

notmuch.el: Add 't' binding to filter results to a specific tag.

This is a convenience function to avoid having to type "tag:" with
the (f)ilter command.

notmuch.el: Add bindings for scrolling to notmuch-search mode.

We turn on the scroll-preserve-screen-position option which seems
like what's desired here, (though that's not what I normally use
when editing files---but I think scrolling through a list of email
threads is different).

Drop inapplicable copyright statements.

I had put these in here since I had originally planned to copy
liberally from the body of the implementation of 'compile in order
to get process output into a buffer. But once I found call-process
in the documentation of emacs, that was all I needed.

And all the code I've written since has been entirely my own with
just the help of emacs documentation.

notmuch-el: Fix implementation of show/hide-thread-ids.

I'm definitely more comfortable with the add-to-invisibility-spec
now than I was when I first wrote these functions, (which weren't
working at all).

notmuch.el: Add command to (a)rchive a thread from notmuch-show mode.

This is our first race-free implementation of archive-thread! It
acts only on the messages explcitly contained in the buffer, not
on an entire thread ID, so it's safe in the face of new messages
have been delivered for this thread since the view was made.

notmuch.el: Don't try to remove an "unread" tag that's not there.

This optimization wouldn't be necessary if we had a nice fast "notmuch
tag" command. But since it's currently fairly slow, (see Xapian defect
250: http://trac.xapian.org/ticket/250), we're willing to take some
extra care to avoid calling "notmuch tag" unnecessarily.

notmuch show: Remove custom "unread" hack, (printing tag in two locations).

I previously had a hack that special-cased the "unread" tag and
printed it on the same line as the message ID. But now that we are
printing all tags at the end of the one-line summary we don't need
this anymore. Get rid of it, and just read "unread" from the list of
tags just like any other tag.

notmuch.el: Add + and - bindings to add/remove tags from messages.

This is in notmuch-show mode rather than in notmuch-search mode,
(where we had + and - working already). This gives the same visual
feedback as in notmuch-search-mode, (the tags are manipulated first in
the database and then the list of tags in the buffer is updated).

notmuch show: Print tags for each message.

This is in the one-line summary so should always be visible even
in our emacs client that's so eager to make things invisible.

notmuch.el: Preserve current thread when refreshing search results.

Otherwise, try to keep point in the same place, (such as when the
current thread has been archived away).

notmuch.el: Add an '=' key to refresh the current view.

This will allow for updates when a separate process (say, a notmuch-
show buffer), has archived messages.

notmuch.el: Mark messages read when the (n)ext keybinding is pressed

Of course, technically, we're removing the "unread" tag, but you
get the idea. :-)

notmuch.el: Hide citations and signatures.

The user can make these visible again by pressing 'c' or 's',
(though we'd like to move to direct manipulation instead soon).

Hide bodies of message that have already been read.

Also hide all markers.

From here, all we really need for legibility is the following:

  * Hide away citations and signatures

  * Call out the one-line summary some way, (larger font size?)

  * Add nesting for replies

notmuch.el: Hide email headers by default.

The display of the header can be toggled with the 'h' key.

notmuch show: Switch to control character to mark sections of output

We were previously using things like "%message{" which were not
guaranteed to never appear in an email message. Using a control
character (^L or '\f' instead of '%') gives us better assurance that
our delimiter doesn't show up in an original email message.

This still isn't entirely safe since we're decoding encoded text in
the body of the email message so almost all bets are off really.

notmuch.el: Make 'n' and 'p' bring the current message to the top.

This is much more convenient for reading the messages, and happens
to match the behavior of sup.

notmuch.el: Add (n)ext and (p)revious bindings to notmuch-show mode.

Almost starting to get usable now. Still need to make it mark messages
as they are read, (by removing the unread tag), and selectively hiding
the full header.

TODO: Add an idea from talking with keithp on the train.

I mentioned the read-only directory optimization to Keith, and he
liked it but wanted to be able to configure it to be fully automated.

notmuch.el: Add '<' and '>' bindings to goto first/last thread.

Also, take care to remove a final blank line to avoid the point
going beyond the last thread in the buffer.

TODO: Organize tasks based on emacs interface, command-line tool, or library.

There are conceptually three different projects here, so it helps
to keep the tasks for each separated.

notmuch.el: Add commands to (s)earch globally, and (f)ilter a search

Also add 'q' and 'x' keybindings to kill the current buffer.

Tweak relative dates to be close to the same length.

Most all of the returned strings will now fill most of a 12-character
string, (depending on the length of the month).

Remove notmuch_message_get_header_size and notmuch_message_get_all_headers

The notmuch.c main program now uses GMime directly rather than using
these functions, and I'd rather not export any functions unless we
have good evidence that the functions are necessary.

notmuch.el: Hide thread IDs in notmuch-search mode.

One more baby step toward something that's pleasant to use.

notmuch.el: Implement visual feedback for add/remove tags.

There's no undo still, but at least you can see what you are doing
now.

Drop date.c file, (use identical function from GMime instead).

We had originally copied this function in at a time when notmuch
wasn't actually depending on the GMime library. Now that it does,
we might as well call the function that exists there rather
than having a private copy of it.

notmuch show: Don't print non-text MIME parts.

Additionally, print a part number for each MIME part so that the
client could (conceivably) ask for the contents of a specific
part by part number.

Fix to decode header values, (primarily subject).

Use GMime function to decode message-header values according to
RFC 2047.

Print "part" markers for each MIME part (with Content-type).

This can allow for the client to hide undesired MIME parts
such as text/html.

notmuch show: Use GMime to decode messages.

We now actually get text content rather than blocks of BASE64, etc.

TODO: Add several items.

These are the things that are actively preventing me from being able
to use notmuch as an email-reading client.

Add an INSTALL file.

The README file was already referring to this, so we actually add it
now.

Add a simple configure script.

This is *not* based on autoconf. In fact, this doesn't actually
configure anything, (one can compile notmuch directly with just
"make" without running configure if the dependencies are all
satisfied).

The only thing that this configure script does is to check for the
presence of the various dependencies and provide some guidance to
the user if they are not all available.

Makefile: Rewrite to use NOTMUCH rather than MY in variable names.

I was about to refer to these names in some documentation, so I
wanted a slightly better name for them.