/* 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"
-#include <stdio.h>
-#include <stdlib.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 <glib.h>
-
-#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
-
-typedef int (*command_function_t) (int argc, char *argv[]);
+typedef int (*command_function_t) (void *ctx, int argc, char *argv[]);
typedef struct command {
const char *name;
command_function_t function;
- const char *usage;
+ const char *arguments;
+ const char *summary;
} command_t;
-/* Read a line from stdin, without any line-terminator character. The
- * return value is a newly allocated string. The caller should free()
- * the string when finished with it.
- *
- * This function returns NULL if EOF is encountered before any
- * characters are input (otherwise it returns those characters).
- */
-char *
-read_line (void)
-{
- char *result = NULL;
- GError *error = NULL;
- GIOStatus g_io_status;
- gsize length;
-
- GIOChannel *channel = g_io_channel_unix_new (fileno (stdin));
+#define MAX_ALIAS_SUBSTITUTIONS 3
- g_io_status = g_io_channel_read_line (channel, &result,
- &length, NULL, &error);
-
- if (g_io_status == EOF)
- goto DONE;
-
- if (g_io_status != G_IO_STATUS_NORMAL) {
- fprintf(stderr, "Read error: %s\n", error->message);
- exit (1);
- }
+typedef struct alias {
+ const char *name;
+ const char *substitutions[MAX_ALIAS_SUBSTITUTIONS];
+} alias_t;
- if (length && result[length - 1] == '\n')
- result[length - 1] = '\0';
+alias_t aliases[] = {
+ { "part", { "show", "--format=raw"}},
+ { "search-tags", {"search", "--output=tags", "*"}}
+};
- DONE:
- g_io_channel_unref (channel);
- return result;
-}
+static int
+notmuch_help_command (void *ctx, int argc, char *argv[]);
+
+static command_t commands[] = {
+ { "setup", notmuch_setup_command,
+ NULL,
+ "Interactively setup notmuch for first use." },
+ { "new", notmuch_new_command,
+ "[options...]",
+ "Find and import new messages to the notmuch database." },
+ { "search", notmuch_search_command,
+ "[options...] <search-terms> [...]",
+ "Search for messages matching the given search terms." },
+ { "show", notmuch_show_command,
+ "<search-terms> [...]",
+ "Show all messages matching the search terms." },
+ { "count", notmuch_count_command,
+ "[options...] <search-terms> [...]",
+ "Count messages matching the search terms." },
+ { "reply", notmuch_reply_command,
+ "[options...] <search-terms> [...]",
+ "Construct a reply template for a set of messages." },
+ { "tag", notmuch_tag_command,
+ "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
+ "Add/remove tags for all messages matching the search terms." },
+ { "dump", notmuch_dump_command,
+ "[<filename>] [--] [<search-terms>]",
+ "Create a plain-text dump of the tags for each message." },
+ { "restore", notmuch_restore_command,
+ "[--accumulate] [<filename>]",
+ "Restore the tags from the given dump file (see 'dump')." },
+ { "config", notmuch_config_command,
+ "[get|set] <section>.<item> [value ...]",
+ "Get or set settings in the notmuch configuration file." },
+ { "help", notmuch_help_command,
+ "[<command>]",
+ "This message, or more detailed help for the named command." }
+};
-typedef struct {
- int messages_total;
- int count;
- int count_last;
- struct timeval tv_start;
- struct timeval tv_last;
-} 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);
-}
+int notmuch_format_version;
-void
-print_formatted_seconds (double seconds)
+static void
+usage (FILE *out)
{
- int hours;
- int minutes;
+ command_t *command;
+ unsigned int i;
- if (seconds > 3600) {
- hours = (int) seconds / 3600;
- printf ("%d:", hours);
- seconds -= hours * 3600;
- }
+ fprintf (out,
+ "Usage: notmuch --help\n"
+ " notmuch --version\n"
+ " notmuch <command> [args...]\n");
+ fprintf (out, "\n");
+ fprintf (out, "The available commands are as follows:\n");
+ fprintf (out, "\n");
- if (seconds > 60)
- minutes = (int) seconds / 60;
- else
- minutes = 0;
+ for (i = 0; i < ARRAY_SIZE (commands); i++) {
+ command = &commands[i];
- printf ("%02d:", minutes);
- seconds -= minutes * 60;
+ fprintf (out, " %-11s %s\n",
+ command->name, command->summary);
+ }
- printf ("%02d", (int) seconds);
+ fprintf (out, "\n");
+ fprintf (out,
+ "Use \"notmuch help <command>\" for more details on each command\n"
+ "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
}
void
-add_files_print_progress (add_files_state_t *state)
+notmuch_exit_if_unsupported_format (void)
{
- struct timeval tv_now;
- double ratio_complete;
- double elapsed_current, rate_current;
- double elapsed_overall;
-
- gettimeofday (&tv_now, NULL);
-
- ratio_complete = (double) state->count / state->messages_total;
- elapsed_current = tv_elapsed (state->tv_last, tv_now);
- rate_current = (state->count - state->count_last) / elapsed_current;
- elapsed_overall = tv_elapsed (state->tv_start, tv_now);
-
- printf ("Added %d messages at %d messages/sec. ",
- state->count, (int) rate_current);
- print_formatted_seconds (elapsed_overall);
- printf ("/");
- print_formatted_seconds (elapsed_overall / ratio_complete);
- printf (" elapsed (%.2f%%). \r", 100 * ratio_complete);
-
- fflush (stdout);
+ if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
+ fprintf (stderr, "\
+A caller requested output format version %d, but the installed notmuch\n\
+CLI only supports up to format version %d. You may need to upgrade your\n\
+notmuch CLI.\n",
+ notmuch_format_version, NOTMUCH_FORMAT_CUR);
+ exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
+ } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
+ fprintf (stderr, "\
+A caller requested output format version %d, which is no longer supported\n\
+by the notmuch CLI (it requires at least version %d). You may need to\n\
+upgrade your notmuch front-end.\n",
+ notmuch_format_version, NOTMUCH_FORMAT_MIN);
+ exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
+ } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
+ /* Warn about old version requests so compatibility issues are
+ * less likely when we drop support for a deprecated format
+ * versions. */
+ fprintf (stderr, "\
+A caller requested deprecated output format version %d, which may not\n\
+be supported in the future.\n", notmuch_format_version);
+ }
+}
- state->tv_last = tv_now;
- state->count_last = state->count;
+static void
+exec_man (const char *page)
+{
+ if (execlp ("man", "man", page, (char *) NULL)) {
+ perror ("exec man");
+ exit (1);
+ }
}
-/* 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)
+static int
+notmuch_help_command (void *ctx, int argc, char *argv[])
{
- DIR *dir;
- struct dirent *entry, *e;
- int entry_length;
- int err;
- char *next;
- struct stat st;
+ command_t *command;
+ unsigned int i;
- dir = opendir (path);
+ argc--; argv++; /* Ignore "help" */
- if (dir == NULL) {
- fprintf (stderr, "Warning: failed to open directory %s: %s\n",
- path, strerror (errno));
- return;
+ if (argc == 0) {
+ printf ("The notmuch mail system.\n\n");
+ usage (stdout);
+ return 0;
}
- 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);
+ if (strcmp (argv[0], "help") == 0) {
+ printf ("The notmuch help system.\n\n"
+ "\tNotmuch uses the man command to display help. In case\n"
+ "\tof difficulties check that MANPATH includes the pages\n"
+ "\tinstalled by notmuch.\n\n"
+ "\tTry \"notmuch help\" for a list of topics.\n");
+ return 0;
+ }
- stat (next, &st);
+ for (i = 0; i < ARRAY_SIZE (commands); i++) {
+ command = &commands[i];
- if (S_ISREG (st.st_mode)) {
- notmuch_database_add_message (notmuch, next);
- state->count++;
- if (state->count % 1000 == 0)
- add_files_print_progress (state);
- } else if (S_ISDIR (st.st_mode)) {
- add_files (notmuch, next, state);
+ if (strcmp (argv[0], command->name) == 0) {
+ char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
+ exec_man (page);
}
-
- free (next);
}
- free (entry);
+ if (strcmp (argv[0], "search-terms") == 0) {
+ exec_man ("notmuch-search-terms");
+ } else if (strcmp (argv[0], "hooks") == 0) {
+ exec_man ("notmuch-hooks");
+ }
- closedir (dir);
+ fprintf (stderr,
+ "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
+ argv[0]);
+ return 1;
}
-/* 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)
+/* Handle the case of "notmuch" being invoked with no command
+ * argument. For now we just call notmuch_setup_command, but we plan
+ * to be more clever about this in the future.
+ */
+static int
+notmuch (void *ctx)
{
- DIR *dir;
- struct dirent *entry, *e;
- int entry_length;
- int err;
- char *next;
+ notmuch_config_t *config;
+ notmuch_bool_t is_new;
+ char *db_path;
struct stat st;
- dir = opendir (path);
+ config = notmuch_config_open (ctx, NULL, &is_new);
- if (dir == NULL) {
- fprintf (stderr, "Warning: failed to open directory %s: %s\n",
- path, strerror (errno));
- return;
+ /* If the user has never configured notmuch, then run
+ * notmuch_setup_command which will give a nice welcome message,
+ * and interactively guide the user through the configuration. */
+ if (is_new) {
+ notmuch_config_close (config);
+ return notmuch_setup_command (ctx, 0, NULL);
}
- 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;
+ /* Notmuch is already configured, but is there a database? */
+ db_path = talloc_asprintf (ctx, "%s/%s",
+ notmuch_config_get_database_path (config),
+ ".notmuch");
+ if (stat (db_path, &st)) {
+ notmuch_config_close (config);
+ if (errno != ENOENT) {
+ fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
+ db_path, strerror (errno));
+ return 1;
}
-
- 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);
+ printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
+ db_path);
+ printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
+ "Note that the first run of \"notmuch new\" can take a very long time\n"
+ "and that the resulting database will use roughly the same amount of\n"
+ "storage space as the email being indexed.\n\n");
+ return 0;
}
- free (entry);
+ printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
+ "At this point you can start exploring the functionality of notmuch by\n"
+ "using commands such as:\n\n"
+ "\tnotmuch search tag:inbox\n\n"
+ "\tnotmuch search to:\"%s\"\n\n"
+ "\tnotmuch search from:\"%s\"\n\n"
+ "\tnotmuch search subject:\"my favorite things\"\n\n"
+ "See \"notmuch help search\" for more details.\n\n"
+ "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
+ "from a search. Finally, you may want to explore using a more sophisticated\n"
+ "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
+ "or any other interface described at http://notmuchmail.org\n\n"
+ "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
+ "Have fun, and may your inbox never have much mail.\n\n",
+ notmuch_config_get_user_name (config),
+ notmuch_config_get_user_primary_email (config));
+
+ notmuch_config_close (config);
- closedir (dir);
+ return 0;
}
int
-setup_command (int argc, char *argv[])
+main (int argc, char *argv[])
{
- notmuch_database_t *notmuch;
- char *mail_directory;
- int count;
- add_files_state_t add_files_state;
- double elapsed;
-
- 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"
- "but the only files it contains should be individual email messages.\n"
- "Either maildir or mh format directories are fine, but you will want to\n"
- "move away any auxiliary files maintained by other email programs.\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");
-
- printf ("Top-level mail directory [~/mail]: ");
- fflush (stdout);
-
- mail_directory = read_line ();
-
- if (mail_directory == NULL || strlen (mail_directory) == 0) {
- char *home;
-
- if (mail_directory)
- free (mail_directory);
-
- home = getenv ("HOME");
- if (!home) {
- fprintf (stderr, "Error: No mail directory provided HOME environment variable is not set.\n");
- fprintf (stderr, "Cowardly refusing to just guess where your mail might be.\n");
- exit (1);
- }
-
- mail_directory = g_strdup_printf ("%s/mail", home);
- }
-
- 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);
+ void *local;
+ command_t *command;
+ alias_t *alias;
+ unsigned int i, j;
+ const char **argv_local;
- printf ("Next, we'll inspect the messages and create a database of threads:\n");
+ talloc_enable_null_tracking ();
- add_files_state.messages_total = count;
- add_files_state.count = 0;
- add_files_state.count_last = 0;
- gettimeofday (&add_files_state.tv_start, NULL);
- add_files_state.tv_last = add_files_state.tv_start;
+ local = talloc_new (NULL);
- add_files (notmuch, mail_directory, &add_files_state);
+ g_mime_init (0);
+ g_type_init ();
- gettimeofday (&add_files_state.tv_last, NULL);
- elapsed = tv_elapsed (add_files_state.tv_start,
- add_files_state.tv_last);
- 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));
+ /* Globally default to the current output format version. */
+ notmuch_format_version = NOTMUCH_FORMAT_CUR;
- notmuch_database_close (notmuch);
+ if (argc == 1)
+ return notmuch (local);
- free (mail_directory);
-
- return 0;
-}
+ if (strcmp (argv[1], "--help") == 0)
+ return notmuch_help_command (NULL, argc - 1, &argv[1]);
-int
-search_command (int argc, char *argv[])
-{
- fprintf (stderr, "Error: search is not implemented yet.\n");
- return 1;
-}
+ if (strcmp (argv[1], "--version") == 0) {
+ printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
+ return 0;
+ }
-int
-show_command (int argc, char *argv[])
-{
- fprintf (stderr, "Error: show-thread is not implemented yet.\n");
- return 1;
-}
+ for (i = 0; i < ARRAY_SIZE (aliases); i++) {
+ alias = &aliases[i];
-command_t commands[] = {
- { "setup", setup_command,
- "Interactively setup notmuch for first use (no arguments).\n"
- "\t\tInvoking notmuch with no command argument will run setup if\n"
- "\t\the setup command has not previously been completed." },
- { "search", search_command,
- "Search for threads matching the given search terms." },
- { "show", show_command,
- "Show the thread with the given thread ID (see 'search')." }
-};
+ if (strcmp (argv[1], alias->name) == 0)
+ {
+ int substitutions;
-void
-usage (void)
-{
- command_t *command;
- int i;
+ argv_local = talloc_size (local, sizeof (char *) *
+ (argc + MAX_ALIAS_SUBSTITUTIONS - 1));
+ if (argv_local == NULL) {
+ fprintf (stderr, "Out of memory.\n");
+ return 1;
+ }
- fprintf (stderr, "Usage: notmuch <command> [args...]\n");
- fprintf (stderr, "\n");
- fprintf (stderr, "Where <command> is one of the following:\n");
- fprintf (stderr, "\n");
+ /* Copy all substution arguments from the alias. */
+ argv_local[0] = argv[0];
+ for (j = 0; j < MAX_ALIAS_SUBSTITUTIONS; j++) {
+ if (alias->substitutions[j] == NULL)
+ break;
+ argv_local[j+1] = alias->substitutions[j];
+ }
+ substitutions = j;
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ /* And copy all original arguments (skipping the argument
+ * that matched the alias of course. */
+ for (j = 2; j < (unsigned) argc; j++) {
+ argv_local[substitutions+j-1] = argv[j];
+ }
- fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage);
+ argc += substitutions - 1;
+ argv = (char **) argv_local;
+ }
}
-}
-
-int
-main (int argc, char *argv[])
-{
- command_t *command;
- int i;
-
- if (argc == 1)
- return setup_command (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 - 1, &argv[1]);
}
- 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