/* 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program. If not, see http://www.gnu.org/licenses/ .
+ * along with this program. If not, see https://www.gnu.org/licenses/ .
*
- * Author: Carl Worth <cworth@cworth.org>
+ * Authors: Carl Worth <cworth@cworth.org>
+ * Keith Packard <keithp@keithp.com>
*/
-#ifndef _GNU_SOURCE
-#define _GNU_SOURCE /* for getline */
-#endif
-#include <stdio.h>
-
-#include "notmuch.h"
-
-/* This is separate from notmuch-private.h because we're trying to
- * keep notmuch.c from looking into any internals, (which helps us
- * develop notmuch.h into a plausible library interface).
- */
-#include "xutil.h"
-
-#include <stddef.h>
-#include <string.h>
-#include <sys/stat.h>
-#include <sys/time.h>
-#include <unistd.h>
-#include <dirent.h>
-#include <errno.h>
-
-#include <talloc.h>
-
-#define unused(x) x __attribute__ ((unused))
+#include "notmuch-client.h"
-/* There's no point in continuing when we've detected that we've done
- * something wrong internally (as opposed to the user passing in a
- * bogus value).
+/*
+ * Notmuch subcommand hook.
*
- * Note that __location__ comes from talloc.h.
+ * The return value will be used as notmuch exit status code,
+ * preferrably EXIT_SUCCESS or EXIT_FAILURE.
*/
-#define INTERNAL_ERROR(format, ...) \
- do { \
- fprintf(stderr, \
- "Internal error: " format " (%s)\n", \
- ##__VA_ARGS__, __location__); \
- exit (1); \
- } while (0)
-
-#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
-
-typedef int (*command_function_t) (int argc, char *argv[]);
+typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
typedef struct command {
const char *name;
command_function_t function;
- const char *usage;
+ notmuch_bool_t create_config;
+ const char *summary;
} command_t;
-typedef void (*add_files_callback_t) (notmuch_message_t *message);
-
-typedef struct {
- int ignore_read_only_directories;
- int saw_read_only_directory;
-
- int total_files;
- int processed_files;
- int added_messages;
- struct timeval tv_start;
-
- add_files_callback_t callback;
-} add_files_state_t;
-
-static void
-chomp_newline (char *str)
-{
- if (str && str[strlen(str)-1] == '\n')
- str[strlen(str)-1] = '\0';
-}
+static int
+notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
-/* Compute the number of seconds elapsed from start to end. */
-static double
-tv_elapsed (struct timeval start, struct timeval end)
-{
- return ((end.tv_sec - start.tv_sec) +
- (end.tv_usec - start.tv_usec) / 1e6);
-}
+static int
+notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
-static void
-print_formatted_seconds (double seconds)
-{
- int hours;
- int minutes;
+static int
+_help_for (const char *topic);
- if (seconds < 1) {
- printf ("almost no time");
- return;
- }
+static notmuch_bool_t print_version = FALSE, print_help = FALSE;
+char *notmuch_requested_db_uuid = NULL;
- if (seconds > 3600) {
- hours = (int) seconds / 3600;
- printf ("%dh ", hours);
- seconds -= hours * 3600;
- }
+const notmuch_opt_desc_t notmuch_shared_options [] = {
+ { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
+ { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
+ { NOTMUCH_OPT_STRING, ¬much_requested_db_uuid, "uuid", 'u', 0 },
+ {0, 0, 0, 0, 0}
+};
- if (seconds > 60) {
- minutes = (int) seconds / 60;
- printf ("%dm ", minutes);
- seconds -= minutes * 60;
+/* any subcommand wanting to support these options should call
+ * inherit notmuch_shared_options and call
+ * notmuch_process_shared_options (subcommand_name);
+ */
+void
+notmuch_process_shared_options (const char *subcommand_name) {
+ if (print_version) {
+ printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
+ exit (EXIT_SUCCESS);
}
- printf ("%ds", (int) seconds);
-}
-
-static 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->processed_files) / elapsed_overall;
-
- printf ("Processed %d", state->processed_files);
-
- if (state->total_files) {
- printf (" of %d files (", state->total_files);
- print_formatted_seconds ((state->total_files - state->processed_files) /
- rate_overall);
- printf (" remaining). \r");
- } else {
- printf (" files (%d files/sec.) \r", (int) rate_overall);
+ if (print_help) {
+ int ret = _help_for (subcommand_name);
+ exit (ret);
}
-
- fflush (stdout);
}
-/* Examine 'path' recursively as follows:
- *
- * o Ask the filesystem for the mtime of 'path' (path_mtime)
- *
- * o Ask the database for its timestamp of 'path' (path_dbtime)
- *
- * o If 'path_mtime' > 'path_dbtime'
- *
- * o For each regular file in 'path' with mtime newer than the
- * 'path_dbtime' call add_message to add the file to the
- * database.
- *
- * o For each sub-directory of path, recursively call into this
- * same function.
- *
- * o Tell the database to update its time of 'path' to 'path_mtime'
- *
- * The 'struct stat *st' must point to a structure that has already
- * been initialized for 'path' by calling stat().
+/* This is suitable for subcommands that do not actually open the
+ * database.
*/
-static notmuch_status_t
-add_files_recursive (notmuch_database_t *notmuch,
- const char *path,
- struct stat *st,
- add_files_state_t *state)
+int notmuch_minimal_options (const char *subcommand_name,
+ int argc, char **argv)
{
- DIR *dir = NULL;
- struct dirent *e, *entry = NULL;
- int entry_length;
- int err;
- char *next = NULL;
- time_t path_mtime, path_dbtime;
- notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
- notmuch_message_t *message = NULL, **closure;
-
- /* If we're told to, we bail out on encountering a read-only
- * directory, (with this being a clear clue from the user to
- * Notmuch that new mail won't be arriving there and we need not
- * look. */
- if (state->ignore_read_only_directories &&
- (st->st_mode & S_IWUSR) == 0)
- {
- state->saw_read_only_directory = TRUE;
- goto DONE;
- }
-
- path_mtime = st->st_mtime;
-
- path_dbtime = notmuch_database_get_timestamp (notmuch, path);
+ int opt_index;
- dir = opendir (path);
- if (dir == NULL) {
- fprintf (stderr, "Error opening directory %s: %s\n",
- path, strerror (errno));
- ret = NOTMUCH_STATUS_FILE_ERROR;
- goto DONE;
- }
+ notmuch_opt_desc_t options[] = {
+ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
+ { 0, 0, 0, 0, 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));
- ret = NOTMUCH_STATUS_FILE_ERROR;
- goto DONE;
- }
+ opt_index = parse_arguments (argc, argv, options, 1);
- if (e == NULL)
- break;
+ if (opt_index < 0)
+ return -1;
- /* If this directory hasn't been modified since the last
- * add_files, then we only need to look further for
- * sub-directories. */
- if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
- continue;
-
- /* 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 = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
-
- if (stat (next, st)) {
- fprintf (stderr, "Error reading %s: %s\n",
- next, strerror (errno));
- ret = NOTMUCH_STATUS_FILE_ERROR;
- continue;
- }
-
- if (S_ISREG (st->st_mode)) {
- /* If the file hasn't been modified since the last
- * add_files, then we need not look at it. */
- if (st->st_mtime > path_dbtime) {
- state->processed_files++;
-
- if (state->callback)
- closure = &message;
- else
- closure = NULL;
-
- status = notmuch_database_add_message (notmuch, next, closure);
- switch (status) {
- /* success */
- case NOTMUCH_STATUS_SUCCESS:
- state->added_messages++;
- if (state->callback)
- (state->callback) (message);
- break;
- /* Non-fatal issues (go on to next file) */
- case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
- /* Stay silent on this one. */
- break;
- case NOTMUCH_STATUS_FILE_NOT_EMAIL:
- fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
- next);
- break;
- /* Fatal issues. Don't process anymore. */
- case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
- case NOTMUCH_STATUS_OUT_OF_MEMORY:
- fprintf (stderr, "Error: %s. Halting processing.\n",
- notmuch_status_to_string (status));
- ret = status;
- goto DONE;
- default:
- case NOTMUCH_STATUS_FILE_ERROR:
- case NOTMUCH_STATUS_NULL_POINTER:
- case NOTMUCH_STATUS_TAG_TOO_LONG:
- case NOTMUCH_STATUS_LAST_STATUS:
- INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
- goto DONE;
- }
-
- if (message) {
- notmuch_message_destroy (message);
- message = NULL;
- }
-
- if (state->processed_files % 1000 == 0)
- add_files_print_progress (state);
- }
- } else if (S_ISDIR (st->st_mode)) {
- status = add_files_recursive (notmuch, next, st, state);
- if (status && ret == NOTMUCH_STATUS_SUCCESS)
- ret = status;
- }
-
- talloc_free (next);
- next = NULL;
- }
-
- status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
- if (status && ret == NOTMUCH_STATUS_SUCCESS)
- ret = status;
+ /* We can't use argv here as it is sometimes NULL */
+ notmuch_process_shared_options (subcommand_name);
+ return opt_index;
+}
- DONE:
- if (next)
- talloc_free (next);
- if (entry)
- free (entry);
- if (dir)
- closedir (dir);
+static command_t commands[] = {
+ { NULL, notmuch_command, TRUE,
+ "Notmuch main command." },
+ { "setup", notmuch_setup_command, TRUE,
+ "Interactively set up notmuch for first use." },
+ { "new", notmuch_new_command, FALSE,
+ "Find and import new messages to the notmuch database." },
+ { "insert", notmuch_insert_command, FALSE,
+ "Add a new message into the maildir and notmuch database." },
+ { "search", notmuch_search_command, FALSE,
+ "Search for messages matching the given search terms." },
+ { "address", notmuch_address_command, FALSE,
+ "Get addresses from messages matching the given search terms." },
+ { "show", notmuch_show_command, FALSE,
+ "Show all messages matching the search terms." },
+ { "count", notmuch_count_command, FALSE,
+ "Count messages matching the search terms." },
+ { "reply", notmuch_reply_command, FALSE,
+ "Construct a reply template for a set of messages." },
+ { "tag", notmuch_tag_command, FALSE,
+ "Add/remove tags for all messages matching the search terms." },
+ { "dump", notmuch_dump_command, FALSE,
+ "Create a plain-text dump of the tags for each message." },
+ { "restore", notmuch_restore_command, FALSE,
+ "Restore the tags from the given dump file (see 'dump')." },
+ { "compact", notmuch_compact_command, FALSE,
+ "Compact the notmuch database." },
+ { "config", notmuch_config_command, FALSE,
+ "Get or set settings in the notmuch configuration file." },
+ { "help", notmuch_help_command, TRUE, /* create but don't save config */
+ "This message, or more detailed help for the named command." }
+};
- return ret;
-}
+typedef struct help_topic {
+ const char *name;
+ const char *summary;
+} help_topic_t;
+
+static help_topic_t help_topics[] = {
+ { "search-terms",
+ "Common search term syntax." },
+ { "hooks",
+ "Hooks that will be run before or after certain commands." },
+};
-/* This is the top-level entry point for add_files. It does a couple
- * of error checks, and then calls into the recursive function,
- * (avoiding the repeating of these error checks at every
- * level---which would be useless becaues we already do a stat() at
- * the level above). */
-static notmuch_status_t
-add_files (notmuch_database_t *notmuch,
- const char *path,
- add_files_state_t *state)
+static command_t *
+find_command (const char *name)
{
- struct stat st;
+ size_t i;
- if (stat (path, &st)) {
- fprintf (stderr, "Error reading directory %s: %s\n",
- path, strerror (errno));
- return NOTMUCH_STATUS_FILE_ERROR;
- }
-
- if (! S_ISDIR (st.st_mode)) {
- fprintf (stderr, "Error: %s is not a directory.\n", path);
- return NOTMUCH_STATUS_FILE_ERROR;
- }
+ for (i = 0; i < ARRAY_SIZE (commands); i++)
+ if ((!name && !commands[i].name) ||
+ (name && commands[i].name && strcmp (name, commands[i].name) == 0))
+ return &commands[i];
- return add_files_recursive (notmuch, path, &st, state);
+ return NULL;
}
-/* 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). */
+int notmuch_format_version;
+
static void
-count_files (const char *path, int *count)
+usage (FILE *out)
{
- DIR *dir;
- struct dirent *e, *entry = NULL;
- 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));
- goto DONE;
- }
-
- 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);
- goto DONE;
- }
-
- if (e == NULL)
- break;
+ command_t *command;
+ help_topic_t *topic;
+ unsigned int i;
- /* 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;
- }
+ 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 (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
- next = NULL;
- fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
- path, entry->d_name);
- continue;
- }
+ for (i = 0; i < ARRAY_SIZE (commands); i++) {
+ command = &commands[i];
- stat (next, &st);
+ if (command->name)
+ fprintf (out, " %-12s %s\n", command->name, command->summary);
+ }
- 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);
- }
+ fprintf (out, "\n");
+ fprintf (out, "Additional help topics are as follows:\n");
+ fprintf (out, "\n");
- free (next);
+ for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
+ topic = &help_topics[i];
+ fprintf (out, " %-12s %s\n", topic->name, topic->summary);
}
- DONE:
- if (entry)
- free (entry);
-
- closedir (dir);
+ fprintf (out, "\n");
+ fprintf (out,
+ "Use \"notmuch help <command or topic>\" for more details "
+ "on each command or topic.\n\n");
}
-static int
-setup_command (unused (int argc), unused (char *argv[]))
+void
+notmuch_exit_if_unsupported_format (void)
{
- notmuch_database_t *notmuch = NULL;
- char *default_path, *mail_directory = NULL;
- size_t line_size;
- int count;
- add_files_state_t add_files_state;
- double elapsed;
- struct timeval tv_now;
- notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
-
- 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);
-
- getline (&mail_directory, &line_size, stdin);
- chomp_newline (mail_directory);
-
- printf ("\n");
-
- 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);
- ret = NOTMUCH_STATUS_FILE_ERROR;
- goto DONE;
+ 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_MIN_ACTIVE) {
+ /* 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);
}
+}
- 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.ignore_read_only_directories = FALSE;
- add_files_state.saw_read_only_directory = FALSE;
- add_files_state.total_files = count;
- add_files_state.processed_files = 0;
- add_files_state.added_messages = 0;
- add_files_state.callback = NULL;
- gettimeofday (&add_files_state.tv_start, NULL);
-
- ret = add_files (notmuch, mail_directory, &add_files_state);
-
- gettimeofday (&tv_now, NULL);
- elapsed = tv_elapsed (add_files_state.tv_start,
- tv_now);
- printf ("Processed %d %s in ", add_files_state.processed_files,
- add_files_state.processed_files == 1 ?
- "file" : "total files");
- print_formatted_seconds (elapsed);
- if (elapsed > 1) {
- printf (" (%d files/sec.). \n",
- (int) (add_files_state.processed_files / elapsed));
- } else {
- printf (". \n");
- }
- if (add_files_state.added_messages) {
- printf ("Added %d %s to the database.\n\n",
- add_files_state.added_messages,
- add_files_state.added_messages == 1 ?
- "message" : "unique messages");
- }
+void
+notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
+{
+ const char *uuid = NULL;
- printf ("When new mail is delivered to %s in the future,\n"
- "run \"notmuch new\" to add it to the database.\n\n",
- mail_directory);
+ if (!notmuch_requested_db_uuid)
+ return;
+ IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
- if (ret) {
- printf ("Note: At least one error was encountered: %s\n",
- notmuch_status_to_string (ret));
+ if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
+ fprintf (stderr, "Error: requested database revision %s does not match %s\n",
+ notmuch_requested_db_uuid, uuid);
+ exit (1);
}
-
- DONE:
- if (mail_directory)
- free (mail_directory);
- if (notmuch)
- notmuch_database_close (notmuch);
-
- return ret;
}
static void
-tag_inbox_and_unread (notmuch_message_t *message)
+exec_man (const char *page)
{
- notmuch_message_add_tag (message, "inbox");
- notmuch_message_add_tag (message, "unread");
+ if (execlp ("man", "man", page, (char *) NULL)) {
+ perror ("exec man");
+ exit (1);
+ }
}
static int
-new_command (unused (int argc), unused (char *argv[]))
+_help_for (const char *topic_name)
{
- notmuch_database_t *notmuch;
- const char *mail_directory;
- add_files_state_t add_files_state;
- double elapsed;
- struct timeval tv_now;
- int ret = 0;
-
- notmuch = notmuch_database_open (NULL);
- if (notmuch == NULL) {
- ret = 1;
- goto DONE;
- }
+ command_t *command;
+ help_topic_t *topic;
+ unsigned int i;
- mail_directory = notmuch_database_get_path (notmuch);
-
- add_files_state.ignore_read_only_directories = TRUE;
- add_files_state.saw_read_only_directory = FALSE;
- add_files_state.total_files = 0;
- add_files_state.processed_files = 0;
- add_files_state.added_messages = 0;
- add_files_state.callback = tag_inbox_and_unread;
- gettimeofday (&add_files_state.tv_start, NULL);
-
- ret = add_files (notmuch, mail_directory, &add_files_state);
-
- gettimeofday (&tv_now, NULL);
- elapsed = tv_elapsed (add_files_state.tv_start,
- tv_now);
- if (add_files_state.processed_files) {
- printf ("Processed %d %s in ", add_files_state.processed_files,
- add_files_state.processed_files == 1 ?
- "file" : "total files");
- print_formatted_seconds (elapsed);
- if (elapsed > 1) {
- printf (" (%d files/sec.). \n",
- (int) (add_files_state.processed_files / elapsed));
- } else {
- printf (". \n");
- }
- }
- if (add_files_state.added_messages) {
- printf ("Added %d new %s to the database (not much, really).\n",
- add_files_state.added_messages,
- add_files_state.added_messages == 1 ?
- "message" : "messages");
- } else {
- printf ("No new mail---and that's not much.\n");
+ if (!topic_name) {
+ printf ("The notmuch mail system.\n\n");
+ usage (stdout);
+ return EXIT_SUCCESS;
}
- if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
- printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
- "they will never receive new mail), marking these directores as\n"
- "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
- "much more efficient (it won't even look in those directories).\n");
+ if (strcmp (topic_name, "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 EXIT_SUCCESS;
}
- if (ret) {
- printf ("\nNote: At least one error was encountered: %s\n",
- notmuch_status_to_string (ret));
+ command = find_command (topic_name);
+ if (command) {
+ char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
+ exec_man (page);
}
- DONE:
- if (notmuch)
- notmuch_database_close (notmuch);
+ for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
+ topic = &help_topics[i];
+ if (strcmp (topic_name, topic->name) == 0) {
+ char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
+ exec_man (page);
+ }
+ }
- return ret;
+ fprintf (stderr,
+ "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
+ topic_name);
+ return EXIT_FAILURE;
}
static int
-search_command (int argc, char *argv[])
+notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
{
- void *local = talloc_new (NULL);
- notmuch_database_t *notmuch = NULL;
- notmuch_query_t *query;
- notmuch_thread_results_t *results;
- notmuch_thread_t *thread;
- notmuch_tags_t *tags;
- char *query_str;
- int i;
- notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
-
- notmuch = notmuch_database_open (NULL);
- if (notmuch == NULL) {
- ret = 1;
- goto DONE;
- }
-
- /* XXX: Should add xtalloc wrappers here and use them. */
- query_str = talloc_strdup (local, "");
-
- for (i = 0; i < argc; i++) {
- if (i != 0)
- query_str = talloc_asprintf_append (query_str, " ");
+ int opt_index;
- query_str = talloc_asprintf_append (query_str, "%s", argv[i]);
- }
-
- query = notmuch_query_create (notmuch, query_str);
- if (query == NULL) {
- fprintf (stderr, "Out of memory\n");
- ret = 1;
- goto DONE;
- }
+ opt_index = notmuch_minimal_options ("help", argc, argv);
+ if (opt_index < 0)
+ return EXIT_FAILURE;
- for (results = notmuch_query_search_threads (query);
- notmuch_thread_results_has_more (results);
- notmuch_thread_results_advance (results))
- {
- int first = 1;
-
- thread = notmuch_thread_results_get (results);
-
- printf ("%s %s",
- notmuch_thread_get_thread_id (thread),
- notmuch_thread_get_subject (thread));
-
- printf (" (");
- for (tags = notmuch_thread_get_tags (thread);
- notmuch_tags_has_more (tags);
- notmuch_tags_advance (tags))
- {
- if (! first)
- printf (" ");
- printf ("%s", notmuch_tags_get (tags));
- first = 0;
- }
- printf (")\n");
+ /* skip at least subcommand argument */
+ argc-= opt_index;
+ argv+= opt_index;
- notmuch_thread_destroy (thread);
+ if (argc == 0) {
+ return _help_for (NULL);
}
- notmuch_query_destroy (query);
-
- DONE:
- if (notmuch)
- notmuch_database_close (notmuch);
- talloc_free (local);
-
- return ret;
+ return _help_for (argv[0]);
}
+/* 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
-show_command (unused (int argc), unused (char *argv[]))
+notmuch_command (notmuch_config_t *config,
+ unused(int argc), unused(char *argv[]))
{
- fprintf (stderr, "Error: show is not implemented yet.\n");
- return 1;
+ char *db_path;
+ struct stat st;
+
+ /* 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 (notmuch_config_is_new (config))
+ return notmuch_setup_command (config, 0, NULL);
+
+ /* Notmuch is already configured, but is there a database? */
+ db_path = talloc_asprintf (config, "%s/%s",
+ notmuch_config_get_database_path (config),
+ ".notmuch");
+ if (stat (db_path, &st)) {
+ if (errno != ENOENT) {
+ fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
+ db_path, strerror (errno));
+ return EXIT_FAILURE;
+ }
+ 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 EXIT_SUCCESS;
+ }
+
+ 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 https://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));
+
+ return EXIT_SUCCESS;
}
-static int
-dump_command (int argc, char *argv[])
+/*
+ * Try to run subcommand in argv[0] as notmuch- prefixed external
+ * command. argv must be NULL terminated (argv passed to main always
+ * is).
+ *
+ * Does not return if the external command is found and
+ * executed. Return TRUE if external command is not found. Return
+ * FALSE on errors.
+ */
+static notmuch_bool_t try_external_command(char *argv[])
{
- FILE *output = NULL;
- notmuch_database_t *notmuch = NULL;
- notmuch_query_t *query;
- notmuch_message_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[0], strerror (errno));
- ret = 1;
- goto DONE;
- }
- } else {
- output = stdout;
- }
+ char *old_argv0 = argv[0];
+ notmuch_bool_t ret = TRUE;
- notmuch = notmuch_database_open (NULL);
- if (notmuch == NULL) {
- ret = 1;
- goto DONE;
- }
+ argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
- query = notmuch_query_create (notmuch, "");
- if (query == NULL) {
- fprintf (stderr, "Out of memory\n");
- ret = 1;
- goto DONE;
+ /*
+ * This will only return on errors. Not finding an external
+ * command (ENOENT) is not an error from our perspective.
+ */
+ execvp (argv[0], argv);
+ if (errno != ENOENT) {
+ fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
+ argv[0], strerror(errno));
+ ret = FALSE;
}
- notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
-
- for (results = notmuch_query_search_messages (query);
- notmuch_message_results_has_more (results);
- notmuch_message_results_advance (results))
- {
- int first = 1;
- message = notmuch_message_results_get (results);
+ talloc_free (argv[0]);
+ argv[0] = old_argv0;
- fprintf (output,
- "%s (", notmuch_message_get_message_id (message));
+ return ret;
+}
- for (tags = notmuch_message_get_tags (message);
- notmuch_tags_has_more (tags);
- notmuch_tags_advance (tags))
- {
- if (! first)
- fprintf (output, " ");
+int
+main (int argc, char *argv[])
+{
+ void *local;
+ char *talloc_report;
+ const char *command_name = NULL;
+ command_t *command;
+ char *config_file_name = NULL;
+ notmuch_config_t *config = NULL;
+ int opt_index;
+ int ret;
- fprintf (output, "%s", notmuch_tags_get (tags));
+ notmuch_opt_desc_t options[] = {
+ { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
+ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
+ { 0, 0, 0, 0, 0 }
+ };
- first = 0;
- }
+ talloc_enable_null_tracking ();
- fprintf (output, ")\n");
+ local = talloc_new (NULL);
- notmuch_message_destroy (message);
- }
+ g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
+#if !GLIB_CHECK_VERSION(2, 35, 1)
+ g_type_init ();
+#endif
- notmuch_query_destroy (query);
+ /* Globally default to the current output format version. */
+ notmuch_format_version = NOTMUCH_FORMAT_CUR;
- DONE:
- if (notmuch)
- notmuch_database_close (notmuch);
- if (output && output != stdout)
- fclose (output);
+ opt_index = parse_arguments (argc, argv, options, 1);
+ if (opt_index < 0) {
+ ret = EXIT_FAILURE;
+ goto DONE;
+ }
- return ret;
-}
+ if (opt_index < argc)
+ command_name = argv[opt_index];
-static int
-restore_command (int argc, char *argv[])
-{
- FILE *input = NULL;
- notmuch_database_t *notmuch = NULL;
- char *line = NULL;
- size_t line_size;
- ssize_t line_len;
- regex_t regex;
- int rerr;
- int ret = 0;
-
- if (argc) {
- input = fopen (argv[0], "r");
- if (input == NULL) {
- fprintf (stderr, "Error opening %s for reading: %s\n",
- argv[0], strerror (errno));
- ret = 1;
- goto DONE;
- }
- } else {
- printf ("No filename given. Reading dump from stdin.\n");
- input = stdin;
- }
+ notmuch_process_shared_options (command_name);
- notmuch = notmuch_database_open (NULL);
- if (notmuch == NULL) {
- ret = 1;
+ command = find_command (command_name);
+ if (!command) {
+ /* This won't return if the external command is found. */
+ if (try_external_command(argv + opt_index))
+ fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+ command_name);
+ ret = EXIT_FAILURE;
goto DONE;
}
- /* Dump output is one line per message. We match a sequence of
- * non-space characters for the message-id, then one or more
- * spaces, then a list of space-separated tags as a sequence of
- * characters within literal '(' and ')'. */
- xregcomp (®ex,
- "^([^ ]+) \\(([^)]*)\\)$",
- REG_EXTENDED);
-
- while ((line_len = getline (&line, &line_size, input)) != -1) {
- regmatch_t match[3];
- char *message_id, *tags, *tag, *next;
- notmuch_message_t *message;
- notmuch_status_t status;
-
- chomp_newline (line);
-
- rerr = xregexec (®ex, line, 3, match, 0);
- if (rerr == REG_NOMATCH)
- {
- fprintf (stderr, "Warning: Ignoring invalid input line: %s\n",
- line);
- continue;
- }
-
- message_id = xstrndup (line + match[1].rm_so,
- match[1].rm_eo - match[1].rm_so);
- tags = xstrndup (line + match[2].rm_so,
- match[2].rm_eo - match[2].rm_so);
-
- if (strlen (tags)) {
-
- message = notmuch_database_find_message (notmuch, message_id);
- if (message == NULL) {
- fprintf (stderr, "Warning: Cannot apply tags to missing message: %s (",
- message_id);
- }
-
- next = tags;
- while (next) {
- tag = strsep (&next, " ");
- if (*tag == '\0')
- continue;
- if (message) {
- status = notmuch_message_add_tag (message, tag);
- if (status) {
- fprintf (stderr,
- "Error applying tag %s to message %s:\n",
- tag, message_id);
- fprintf (stderr, "%s\n",
- notmuch_status_to_string (status));
- }
- } else {
- fprintf (stderr, "%s%s",
- tag == tags ? "" : " ", tag);
- }
- }
-
- if (message)
- notmuch_message_destroy (message);
- else
- fprintf (stderr, ")\n");
- }
- free (message_id);
- free (tags);
+ config = notmuch_config_open (local, config_file_name, command->create_config);
+ if (!config) {
+ ret = EXIT_FAILURE;
+ goto DONE;
}
- regfree (®ex);
+ ret = (command->function)(config, argc - opt_index, argv + opt_index);
DONE:
- if (line)
- free (line);
- if (notmuch)
- notmuch_database_close (notmuch);
- if (input && input != stdin)
- fclose (input);
-
- return ret;
-}
-
-command_t commands[] = {
- { "setup", setup_command,
- "Interactively setup notmuch for first use.\n\n"
- "\t\tInvoking notmuch with no command argument will run setup if\n"
- "\t\tthe setup command has not previously been completed." },
- { "new", new_command,
- "Find and import any new messages.\n\n"
- "\t\tScans all sub-directories of the database, adding new messages\n"
- "\t\tthat are found. Each new message will be tagges 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 tdirectories that will not\n"
- "\t\treceive any new mail (and make \"notmuch new\" faster)." },
- { "search", 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,
- "[<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\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,
- "<filename>\n\n"
- "\t\tRestore the tags from the given dump file (see 'dump')." }
-};
-
-static void
-usage (void)
-{
- command_t *command;
- unsigned int i;
+ if (config)
+ notmuch_config_close (config);
- fprintf (stderr, "Usage: notmuch <command> [args...]\n");
- fprintf (stderr, "\n");
- fprintf (stderr, "Where <command> and [args...] are as follows:\n");
- fprintf (stderr, "\n");
-
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
+ if (talloc_report && strcmp (talloc_report, "") != 0) {
+ /* this relies on the previous call to
+ * talloc_enable_null_tracking
+ */
- fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage);
+ FILE *report = fopen (talloc_report, "w");
+ if (report) {
+ talloc_report_full (NULL, report);
+ } else {
+ ret = 1;
+ fprintf (stderr, "ERROR: unable to write talloc log. ");
+ perror (talloc_report);
+ }
}
-}
-
-int
-main (int argc, char *argv[])
-{
- command_t *command;
- unsigned 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]);
- }
+ talloc_free (local);
- /* 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");
- usage ();
- return 0;
- } else {
- fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);
- usage ();
- return 1;
- }
+ return ret;
}
projects / notmuch / blobdiff