/* notmuch - Not much of an email program, (just index and search)
*
* Copyright © 2009 Carl Worth
+ * Copyright © 2009 Keith Packard
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/ .
*
- * Author: Carl Worth <cworth@cworth.org>
+ * Authors: Carl Worth <cworth@cworth.org>
+ * Keith Packard <keithp@keithp.com>
*/
-#include "notmuch.h"
+#include "notmuch-client.h"
-#ifndef _GNU_SOURCE
-#define _GNU_SOURCE /* for getline */
-#endif
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stddef.h>
-#include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <sys/time.h>
-#include <unistd.h>
-#include <dirent.h>
-#include <errno.h>
-
-#include <talloc.h>
-
-#include <glib.h> /* g_strdup_printf */
-
-#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
-
-typedef int (*command_function_t) (int argc, char *argv[]);
-
-typedef struct command {
- const char *name;
- command_function_t function;
- const char *usage;
-} command_t;
-
-typedef struct {
- int total_messages;
- int count;
- struct timeval tv_start;
-} add_files_state_t;
-
-/* Compute the number of seconds elapsed from start to end. */
-double
-tv_elapsed (struct timeval start, struct timeval end)
-{
- return ((end.tv_sec - start.tv_sec) +
- (end.tv_usec - start.tv_usec) / 1e6);
-}
-
-void
-print_formatted_seconds (double seconds)
-{
- int hours;
- int minutes;
-
- if (seconds > 3600) {
- hours = (int) seconds / 3600;
- printf ("%dh ", hours);
- seconds -= hours * 3600;
- }
-
- if (seconds > 60) {
- minutes = (int) seconds / 60;
- printf ("%dm ", minutes);
- seconds -= minutes * 60;
- }
-
- printf ("%02ds", (int) seconds);
-}
-
-void
-add_files_print_progress (add_files_state_t *state)
-{
- struct timeval tv_now;
- double elapsed_overall, rate_overall;
-
- gettimeofday (&tv_now, NULL);
-
- elapsed_overall = tv_elapsed (state->tv_start, tv_now);
- rate_overall = (state->count) / elapsed_overall;
-
- printf ("Added %d of %d messages (",
- state->count, state->total_messages);
- print_formatted_seconds ((state->total_messages - state->count) /
- rate_overall);
- printf (" remaining).\r");
-
- fflush (stdout);
-}
-
-/* Recursively find all regular files in 'path' and add them to the
- * database. */
-void
-add_files (notmuch_database_t *notmuch, const char *path,
- add_files_state_t *state)
-{
- DIR *dir;
- struct dirent *entry, *e;
- int entry_length;
- int err;
- char *next;
- struct stat st;
- notmuch_status_t status;
-
- dir = opendir (path);
-
- if (dir == NULL) {
- fprintf (stderr, "Warning: failed to open directory %s: %s\n",
- path, strerror (errno));
- return;
- }
-
- entry_length = offsetof (struct dirent, d_name) +
- pathconf (path, _PC_NAME_MAX) + 1;
- entry = malloc (entry_length);
-
- while (1) {
- err = readdir_r (dir, entry, &e);
- if (err) {
- fprintf (stderr, "Error reading directory: %s\n",
- strerror (errno));
- free (entry);
- return;
- }
-
- if (e == NULL)
- break;
-
- /* Ignore special directories to avoid infinite recursion.
- * Also ignore the .notmuch directory.
- */
- /* XXX: Eventually we'll want more sophistication to let the
- * user specify files to be ignored. */
- if (strcmp (entry->d_name, ".") == 0 ||
- strcmp (entry->d_name, "..") == 0 ||
- strcmp (entry->d_name, ".notmuch") ==0)
- {
- continue;
- }
-
- next = g_strdup_printf ("%s/%s", path, entry->d_name);
-
- stat (next, &st);
-
- if (S_ISREG (st.st_mode)) {
- status = notmuch_database_add_message (notmuch, next);
- if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) {
- fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
- next);
- } else {
- state->count++;
- }
- if (state->count % 1000 == 0)
- add_files_print_progress (state);
- } else if (S_ISDIR (st.st_mode)) {
- add_files (notmuch, next, state);
- }
-
- free (next);
- }
-
- free (entry);
-
- closedir (dir);
-}
-
-/* Recursively count all regular files in path and all sub-direcotries
- * of path. The result is added to *count (which should be
- * initialized to zero by the top-level caller before calling
- * count_files). */
-void
-count_files (const char *path, int *count)
-{
- DIR *dir;
- struct dirent *entry, *e;
- int entry_length;
- int err;
- char *next;
- struct stat st;
-
- dir = opendir (path);
-
- if (dir == NULL) {
- fprintf (stderr, "Warning: failed to open directory %s: %s\n",
- path, strerror (errno));
- return;
- }
-
- entry_length = offsetof (struct dirent, d_name) +
- pathconf (path, _PC_NAME_MAX) + 1;
- entry = malloc (entry_length);
-
- while (1) {
- err = readdir_r (dir, entry, &e);
- if (err) {
- fprintf (stderr, "Error reading directory: %s\n",
- strerror (errno));
- free (entry);
- return;
- }
-
- if (e == NULL)
- break;
-
- /* Ignore special directories to avoid infinite recursion.
- * Also ignore the .notmuch directory.
- */
- /* XXX: Eventually we'll want more sophistication to let the
- * user specify files to be ignored. */
- if (strcmp (entry->d_name, ".") == 0 ||
- strcmp (entry->d_name, "..") == 0 ||
- strcmp (entry->d_name, ".notmuch") == 0)
- {
- continue;
- }
-
- next = g_strdup_printf ("%s/%s", path, entry->d_name);
-
- stat (next, &st);
-
- if (S_ISREG (st.st_mode)) {
- *count = *count + 1;
- if (*count % 1000 == 0) {
- printf ("Found %d files so far.\r", *count);
- fflush (stdout);
- }
- } else if (S_ISDIR (st.st_mode)) {
- count_files (next, count);
- }
-
- free (next);
- }
-
- free (entry);
-
- closedir (dir);
-}
-
-int
-setup_command (int argc, char *argv[])
-{
- notmuch_database_t *notmuch;
- char *mail_directory, *default_path;
- size_t line_size;
- int count;
- add_files_state_t add_files_state;
- double elapsed;
- struct timeval tv_now;
-
- printf ("Welcome to notmuch!\n\n");
-
- printf ("The goal of notmuch is to help you manage and search your collection of\n"
- "email, and to efficiently keep up with the flow of email as it comes in.\n\n");
-
- printf ("Notmuch needs to know the top-level directory of your email archive,\n"
- "(where you already have mail stored and where messages will be delivered\n"
- "in the future). This directory can contain any number of sub-directories\n"
- "and primarily just files with indvidual email messages (eg. maildir or mh\n"
- "archives are perfect). If there are other, non-email files (such as\n"
- "indexes maintained by other email programs) then notmuch will do its\n"
- "best to detect those and ignore them.\n\n");
-
- printf ("Mail storage that uses mbox format, (where one mbox file contains many\n"
- "messages), will not work with notmuch. If that's how your mail is currently\n"
- "stored, we recommend you first convert it to maildir format with a utility\n"
- "such as mb2md. In that case, press Control-C now and run notmuch again\n"
- "once the conversion is complete.\n\n");
-
-
- default_path = notmuch_database_default_path ();
- printf ("Top-level mail directory [%s]: ", default_path);
- fflush (stdout);
-
- mail_directory = NULL;
- getline (&mail_directory, &line_size, stdin);
- printf ("\n");
-
- if (mail_directory &&
- mail_directory[strlen(mail_directory)-1] == '\n')
- {
- mail_directory[strlen(mail_directory)-1] = '\0';
- }
-
- if (mail_directory == NULL || strlen (mail_directory) == 0) {
- if (mail_directory)
- free (mail_directory);
- mail_directory = default_path;
- } else {
- /* XXX: Instead of telling the user to use an environment
- * variable here, we should really be writing out a configuration
- * file and loading that on the next run. */
- if (strcmp (mail_directory, default_path)) {
- printf ("Note: Since you are not using the default path, you will want to set\n"
- "the NOTMUCH_BASE environment variable to %s so that\n"
- "future calls to notmuch commands will know where to find your mail.\n",
- mail_directory);
- printf ("For example, if you are using bash for your shell, add:\n\n");
- printf ("\texport NOTMUCH_BASE=%s\n\n", mail_directory);
- printf ("to your ~/.bashrc file.\n\n");
- }
- free (default_path);
- }
-
- notmuch = notmuch_database_create (mail_directory);
- if (notmuch == NULL) {
- fprintf (stderr, "Failed to create new notmuch database at %s\n",
- mail_directory);
- free (mail_directory);
- return 1;
- }
-
- printf ("OK. Let's take a look at the mail we can find in the directory\n");
- printf ("%s ...\n", mail_directory);
-
- count = 0;
- count_files (mail_directory, &count);
-
- printf ("Found %d total files. That's not much mail.\n\n", count);
-
- printf ("Next, we'll inspect the messages and create a database of threads:\n");
-
- add_files_state.total_messages = count;
- add_files_state.count = 0;
- gettimeofday (&add_files_state.tv_start, NULL);
-
- add_files (notmuch, mail_directory, &add_files_state);
-
- gettimeofday (&tv_now, NULL);
- elapsed = tv_elapsed (add_files_state.tv_start,
- tv_now);
- printf ("Added %d total messages in ", add_files_state.count);
- print_formatted_seconds (elapsed);
- printf (" (%d messages/sec.). \n", (int) (add_files_state.count / elapsed));
-
- notmuch_database_close (notmuch);
-
- free (mail_directory);
-
- return 0;
-}
-
-int
-search_command (int argc, char *argv[])
-{
- fprintf (stderr, "Error: search is not implemented yet.\n");
- return 1;
-}
-
-int
-show_command (int argc, char *argv[])
-{
- fprintf (stderr, "Error: show is not implemented yet.\n");
- return 1;
-}
-
-int
-dump_command (int argc, char *argv[])
-{
- FILE *output;
- notmuch_database_t *notmuch = NULL;
- notmuch_query_t *query;
- notmuch_results_t *results;
- notmuch_message_t *message;
- notmuch_tags_t *tags;
- int ret = 0;
-
- if (argc) {
- output = fopen (argv[0], "w");
- if (output == NULL) {
- fprintf (stderr, "Error opening %s for writing: %s\n",
- argv[1], strerror (errno));
- ret = 1;
- goto DONE;
- }
- } else {
- output = stdout;
- }
-
- notmuch = notmuch_database_open (NULL);
- if (notmuch == NULL) {
- ret = 1;
- goto DONE;
- }
-
- query = notmuch_query_create (notmuch, NOTMUCH_QUERY_ALL);
- if (query == NULL) {
- fprintf (stderr, "Out of memory\n");
- ret = 1;
- goto DONE;
- }
-
- notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
-
- for (results = notmuch_query_search (query);
- notmuch_results_has_more (results);
- notmuch_results_advance (results))
- {
- message = notmuch_results_get (results);
-
- fprintf (output,
- "%s (", notmuch_message_get_message_id (message));
-
- for (tags = notmuch_message_get_tags (message);
- notmuch_tags_has_more (tags);
- notmuch_tags_advance (tags))
- {
- int first = 1;
-
- if (! first)
- fprintf (output, " ");
-
- fprintf (output, "%s", notmuch_tags_get (tags));
-
- first = 0;
- }
-
- fprintf (output, ")\n");
- }
-
- notmuch_query_destroy (query);
-
- DONE:
- if (notmuch)
- notmuch_database_close (notmuch);
- if (output != stdout)
- fclose (output);
-
- return ret;
-}
-
-int
-restore_command (int argc, char *argv[])
-{
- fprintf (stderr, "Error: restore is not implemented yet.\n");
- return 1;
-}
+static int
+notmuch_help_command (void *ctx, int argc, char *argv[]);
command_t commands[] = {
- { "setup", setup_command,
- "Interactively setup notmuch for first use.\n"
+ { "setup", notmuch_setup_command,
+ "Interactively setup notmuch for first use.",
+ "\t\tThe setup command is the first command you will run in order\n"
+ "\t\tto start using notmuch. It will prompt you for the directory\n"
+ "\t\tcontaining your email archives, and will then proceed to build\n"
+ "\t\ta database to allow fast searching of that mail.\n\n"
"\t\tInvoking notmuch with no command argument will run setup if\n"
"\t\tthe setup command has not previously been completed." },
- { "search", search_command,
+ { "new", notmuch_new_command,
+ "Find and import any new messages.",
+ "\t\tScans all sub-directories of the database, adding new messages\n"
+ "\t\tthat are found. Each new message will be tagged as both\n"
+ "\t\t\"inbox\" and \"unread\".\n"
+ "\n"
+ "\t\tNote: \"notmuch new\" will skip any read-only directories,\n"
+ "\t\tso you can use that to mark directories that will not\n"
+ "\t\treceive any new mail (and make \"notmuch new\" faster)." },
+ { "search", notmuch_search_command,
"<search-term> [...]\n\n"
- "\t\tSearch for threads matching the given search terms.\n"
- "\t\tOnce we actually implement search we'll document the\n"
- "\t\tsyntax here." },
- { "show", show_command,
- "<thread-id>\n\n"
- "\t\tShow the thread with the given thread ID (see 'search')." },
- { "dump", dump_command,
+ "\t\tSearch for threads matching the given search terms.",
+ "\t\tNote that the individual mail messages will be matched\n"
+ "\t\tagainst the search terms, but the results will be the\n"
+ "\t\tthreads containing the matched messages.\n\n"
+ "\t\tCurrently, in addition to free text (and quoted phrases)\n"
+ "\t\twhich match terms appearing anywhere within an email,\n"
+ "\t\tthe following prefixes can be used to search specific\n"
+ "\t\tportions of an email, (where <brackets> indicate user-\n"
+ "\t\tsupplied values):\n\n"
+ "\t\t\tfrom:<name-or-address>\n"
+ "\t\t\tto:<name-or-address>\n"
+ "\t\t\tsubject:<word-or-quoted-phrase>\n"
+ "\t\t\ttag:<tag>\n"
+ "\t\t\tid:<message-id>\n"
+ "\t\t\tthread:<thread-id>\n\n"
+ "\t\tThe from: prefix is used to match the name or address of\n"
+ "\t\tthe sender of an email message.\n\n"
+ "\t\tThe to: prefix is used to match the names or addresses of\n"
+ "\t\tany recipient of an email message, (whether To, Cc, or Bcc).\n\n"
+ "\t\tAny term prefixed with subject: will match only text from\n"
+ "\t\tthe subject of an email. Quoted phrases are supported when\n"
+ "\t\tsearching with: subject:\"this is a phrase\".\n\n"
+ "\t\tValid tag values include \"inbox\" and \"unread\" by default\n"
+ "\t\tfor new messages added by \"notmuch new\" as well as any other\n"
+ "\t\ttag values added manually with \"notmuch tag\".\n\n"
+ "\t\tMessage ID values are the literal contents of the Message-ID:\n"
+ "\t\theader of email messages, but without the '<','>' delimiters.\n\n"
+ "\t\tThread ID values are generated internally by notmuch but can\n"
+ "\t\tbe seen in the output of \"notmuch search\" for example.\n\n"
+ "\t\tIn addition to individual terms, multiple terms can be\n"
+ "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
+ "\t\tEach term in the query will be implicitly connected by a\n"
+ "\t\tlogical AND if no explicit operator is provided, (except\n"
+ "\t\tthat terms with a common prefix will be implicitly combined\n"
+ "\t\twith OR until we get Xapian defect #402 fixed).\n\n"
+ "\t\tParentheses can also be used to control the combination of\n"
+ "\t\tthe Boolean operators, but will have to be protected from\n"
+ "\t\tinterpretation by the shell, (such as by putting quotation\n"
+ "\t\tmarks around any parenthesized expression)." },
+ { "reply", notmuch_reply_command,
+ "<search-terms> [...]\n\n"
+ "\t\tFormats a reply from a set of existing messages.",
+ "\t\tConstructs a new message as a reply to a set of existing\n"
+ "\t\tmessages. The From: address is used as a To: address\n"
+ "\t\talong with all old To: addresses. All of the Cc: addresses\n"
+ "\t\tare copied as new Cc: addresses. An In-Reply-To: header\n"
+ "\t\twill be constructed from the name and date of the original\n"
+ "\t\tmessage, and the original Message-ID will be added to the\n"
+ "\t\tlist of References in the new message. The text of each\n"
+ "\t\tmessage (as described in the \"show\" command) will be\n"
+ "\t\tpresented, each line prefixed with \"> \" The resulting\n"
+ "\t\tmessage will be dumped to stdout." },
+ { "show", notmuch_show_command,
+ "<search-terms> [...]\n\n"
+ "\t\tShows all messages matching the search terms.",
+ "\t\tSee the documentation of \"notmuch search\" for details\n"
+ "\t\tof the supported syntax of search terms.\n\n"
+ "\t\tA common use of \"notmuch show\" is to display a single\n"
+ "\t\tthread of email messages. For this, use a search term of\n"
+ "\t\t\"thread:<thread-id>\" as can be seen in the first column\n"
+ "\t\tof output from the \"notmuch search\" command.\n\n"
+ "\t\tAll messages will be displayed in date order. The output\n"
+ "\t\tformat is plain-text, with all text-content MIME parts\n"
+ "\t\tdecoded. Various components in the output, ('message',\n"
+ "\t\t'header', 'body', 'attachment', and MIME 'part') will be\n"
+ "\t\tdelimited by easily-parsed markers. Each marker consists\n"
+ "\t\tof a Control-L character (ASCII decimal 12), the name of\n"
+ "\t\tthe marker, and then either an opening or closing brace,\n"
+ "\t\t'{' or '}' to either open or close the component."},
+ { "tag", notmuch_tag_command,
+ "+<tag>|-<tag> [...] [--] <search-term> [...]\n\n"
+ "\t\tAdd/remove tags for all messages matching the search terms.",
+ "\t\tThe search terms are handled exactly as in 'search' so one\n"
+ "\t\tcan use that command first to see what will be modified.\n\n"
+ "\t\tTags prefixed by '+' are added while those prefixed by '-' are\n"
+ "\t\tremoved. For each message, tag removal is before tag addition.\n\n"
+ "\t\tThe beginning of <search-terms> is recognized by the first\n"
+ "\t\targument that begins with neither '+' nor '-'. Support for\n"
+ "\t\tan initial search term beginning with '+' or '-' is provided\n"
+ "\t\tby allowing the user to specify a \"--\" argument to separate\n"
+ "\t\tthe tags from the search terms.\n\n"
+ "\t\tNote: If you run \"notmuch new\" between reading a thread with\n"
+ "\t\t\"notmuch show\" and removing the \"inbox\" tag for that thread\n"
+ "\t\twith \"notmuch tag\" then you create the possibility of moving\n"
+ "\t\tsome messages from that thread out of your inbox without ever\n"
+ "\t\treading them. The easiest way to avoid this problem is to not\n"
+ "\t\trun \"notmuch new\" between reading and removing tags." },
+ { "dump", notmuch_dump_command,
"[<filename>]\n\n"
- "\t\tCreate a plain-text dump of the tags for each message\n"
- "\t\twriting to the given filename, if any, or to stdout.\n"
+ "\t\tCreate a plain-text dump of the tags for each message.",
+ "\t\tOutput is to the given filename, if any, or to stdout.\n"
"\t\tThese tags are the only data in the notmuch database\n"
"\t\tthat can't be recreated from the messages themselves.\n"
"\t\tThe output of notmuch dump is therefore the only\n"
"\t\tcritical thing to backup (and much more friendly to\n"
- "\t\tincremental backup than the native database files." },
- { "restore", restore_command,
+ "\t\tincremental backup than the native database files.)" },
+ { "restore", notmuch_restore_command,
"<filename>\n\n"
- "\t\tRestore the tags from the given dump file (see 'dump')." }
+ "\t\tRestore the tags from the given dump file (see 'dump').",
+ "\t\tNote: The dump file format is specifically chosen to be\n"
+ "\t\tcompatible with the format of files produced by sup-dump.\n"
+ "\t\tSo if you've previously been using sup for mail, then the\n"
+ "\t\t\"notmuch restore\" command provides you a way to import\n"
+ "\t\tall of your tags (or labels as sup calls them)." },
+ { "help", notmuch_help_command,
+ "[<command>]\n\n"
+ "\t\tThis message, or more detailed help for the named command.",
+ "\t\tExcept in this case, where there's not much more detailed\n"
+ "\t\thelp available." }
};
-void
+static void
usage (void)
{
command_t *command;
- int i;
+ unsigned int i;
fprintf (stderr, "Usage: notmuch <command> [args...]\n");
fprintf (stderr, "\n");
for (i = 0; i < ARRAY_SIZE (commands); i++) {
command = &commands[i];
- fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage);
+ fprintf (stderr, "\t%s\t%s\n\n", command->name, command->summary);
+ }
+
+ fprintf (stderr, "Use \"notmuch help <command>\" for more details on each command.\n\n");
+}
+
+static int
+notmuch_help_command (unused (void *ctx), int argc, char *argv[])
+{
+ command_t *command;
+ unsigned int i;
+
+ if (argc == 0) {
+ fprintf (stderr, "The notmuch mail system.\n\n");
+ usage ();
+ return 0;
+ }
+
+ for (i = 0; i < ARRAY_SIZE (commands); i++) {
+ command = &commands[i];
+
+ if (strcmp (argv[0], command->name) == 0) {
+ fprintf (stderr, "Help for \"notmuch %s\":\n\n", argv[0]);
+ fprintf (stderr, "\t%s\t%s\n\n%s\n\n", command->name,
+ command->summary, command->documentation);
+ return 0;
+ }
}
+
+ fprintf (stderr,
+ "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
+ argv[0]);
+ return 1;
}
int
main (int argc, char *argv[])
{
+ void *local = talloc_new (NULL);
command_t *command;
- int i;
+ unsigned int i;
+
+ g_mime_init (0);
if (argc == 1)
- return setup_command (0, NULL);
+ return notmuch_setup_command (local, 0, NULL);
for (i = 0; i < ARRAY_SIZE (commands); i++) {
command = &commands[i];
if (strcmp (argv[1], command->name) == 0)
- return (command->function) (argc - 2, &argv[2]);
+ return (command->function) (local, argc - 2, &argv[2]);
}
/* Don't complain about "help" being an unknown command when we're
about to provide exactly what's wanted anyway. */
- if (strcmp (argv[1], "help") == 0 ||
- strcmp (argv[1], "--help") == 0)
- {
- fprintf (stderr, "The notmuch mail system.\n\n");
- } else {
- fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);
- }
- usage ();
- exit (1);
+ fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+ argv[1]);
- return 0;
+ talloc_free (local);
+
+ return 1;
}
projects / notmuch / blobdiff