#include "notmuch-client.h"
+/*
+ * Notmuch subcommand hook.
+ *
+ * The return value will be used as notmuch exit status code,
+ * preferrably EXIT_SUCCESS or EXIT_FAILURE.
+ */
typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
typedef struct command {
static int
notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
+static int
+_help_for (const char *topic);
+
+static notmuch_bool_t print_version = FALSE, print_help = FALSE;
+char *notmuch_requested_db_uuid = NULL;
+
+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}
+};
+
+/* 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);
+ }
+
+ if (print_help) {
+ int ret = _help_for (subcommand_name);
+ exit (ret);
+ }
+}
+
+/* This is suitable for subcommands that do not actually open the
+ * database.
+ */
+int notmuch_minimal_options (const char *subcommand_name,
+ int argc, char **argv)
+{
+ int opt_index;
+
+ notmuch_opt_desc_t options[] = {
+ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
+ { 0, 0, 0, 0, 0 }
+ };
+
+ opt_index = parse_arguments (argc, argv, options, 1);
+
+ if (opt_index < 0)
+ return -1;
+
+ /* We can't use argv here as it is sometimes NULL */
+ notmuch_process_shared_options (subcommand_name);
+ return opt_index;
+}
+
static command_t commands[] = {
{ NULL, notmuch_command, TRUE,
"Notmuch main command." },
{ "setup", notmuch_setup_command, TRUE,
- "Interactively setup notmuch for first use." },
+ "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,
"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." }
};
+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." },
+};
+
static command_t *
find_command (const char *name)
{
usage (FILE *out)
{
command_t *command;
+ help_topic_t *topic;
unsigned int i;
fprintf (out,
command = &commands[i];
if (command->name)
- fprintf (out, " %-11s %s\n", command->name, command->summary);
+ fprintf (out, " %-12s %s\n", command->name, command->summary);
+ }
+
+ fprintf (out, "\n");
+ fprintf (out, "Additional help topics are as follows:\n");
+ fprintf (out, "\n");
+
+ for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
+ topic = &help_topics[i];
+ fprintf (out, " %-12s %s\n", topic->name, topic->summary);
}
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");
+ "Use \"notmuch help <command or topic>\" for more details "
+ "on each command or topic.\n\n");
}
void
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) {
+ } 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. */
}
}
+void
+notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
+{
+ const char *uuid = NULL;
+
+ if (!notmuch_requested_db_uuid)
+ return;
+ IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
+
+ 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);
+ }
+}
+
static void
exec_man (const char *page)
{
}
static int
-notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
+_help_for (const char *topic_name)
{
command_t *command;
+ help_topic_t *topic;
+ unsigned int i;
- argc--; argv++; /* Ignore "help" */
-
- if (argc == 0) {
+ if (!topic_name) {
printf ("The notmuch mail system.\n\n");
usage (stdout);
- return 0;
+ return EXIT_SUCCESS;
}
- if (strcmp (argv[0], "help") == 0) {
+ 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 0;
+ return EXIT_SUCCESS;
}
- command = find_command (argv[0]);
+ command = find_command (topic_name);
if (command) {
- char *page = talloc_asprintf (config, "notmuch-%s", command->name);
+ char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
exec_man (page);
}
- if (strcmp (argv[0], "search-terms") == 0) {
- exec_man ("notmuch-search-terms");
- } else if (strcmp (argv[0], "hooks") == 0) {
- exec_man ("notmuch-hooks");
+ 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);
+ }
}
fprintf (stderr,
"\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
- argv[0]);
- return 1;
+ topic_name);
+ return EXIT_FAILURE;
+}
+
+static int
+notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
+{
+ int opt_index;
+
+ opt_index = notmuch_minimal_options ("help", argc, argv);
+ if (opt_index < 0)
+ return EXIT_FAILURE;
+
+ /* skip at least subcommand argument */
+ argc-= opt_index;
+ argv+= opt_index;
+
+ if (argc == 0) {
+ return _help_for (NULL);
+ }
+
+ return _help_for (argv[0]);
}
/* Handle the case of "notmuch" being invoked with no command
if (errno != ENOENT) {
fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
db_path, strerror (errno));
- return 1;
+ return EXIT_FAILURE;
}
printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
db_path);
"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;
+ return EXIT_SUCCESS;
}
printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
notmuch_config_get_user_name (config),
notmuch_config_get_user_primary_email (config));
- return 0;
-}
-
-static int
-redirect_stderr (const char * stderr_file)
-{
- if (strcmp (stderr_file, "-") == 0) {
- if (dup2 (STDOUT_FILENO, STDERR_FILENO) < 0) {
- perror ("dup2");
- return 1;
- }
- } else {
- int fd = open (stderr_file, O_WRONLY|O_CREAT|O_TRUNC, 0666);
- if (fd < 0) {
- fprintf (stderr, "Error: Cannot redirect stderr to '%s': %s\n",
- stderr_file, strerror (errno));
- return 1;
- }
- if (fd != STDERR_FILENO) {
- if (dup2 (fd, STDERR_FILENO) < 0) {
- perror ("dup2");
- return 1;
- }
- close (fd);
- }
- }
- return 0;
+ return EXIT_SUCCESS;
}
int
const char *command_name = NULL;
command_t *command;
char *config_file_name = NULL;
- char *stderr_file = NULL;
- notmuch_config_t *config;
- notmuch_bool_t print_help=FALSE, print_version=FALSE;
+ notmuch_config_t *config = NULL;
int opt_index;
- int ret = 0;
+ int ret;
notmuch_opt_desc_t options[] = {
- { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
- { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
{ NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
- { NOTMUCH_OPT_STRING, &stderr_file, "stderr", '\0', 0 },
+ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
{ 0, 0, 0, 0, 0 }
};
local = talloc_new (NULL);
- g_mime_init (0);
+ g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
+#if !GLIB_CHECK_VERSION(2, 35, 1)
g_type_init ();
+#endif
/* Globally default to the current output format version. */
notmuch_format_version = NOTMUCH_FORMAT_CUR;
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0) {
- /* diagnostics already printed */
- return 1;
- }
-
- if (stderr_file && redirect_stderr (stderr_file) != 0) {
- /* error already printed */
- return 1;
- }
- if (print_help)
- return notmuch_help_command (NULL, argc - 1, &argv[1]);
-
- if (print_version) {
- printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
- return 0;
+ ret = EXIT_FAILURE;
+ goto DONE;
}
if (opt_index < argc)
command_name = argv[opt_index];
+ notmuch_process_shared_options (command_name);
+
command = find_command (command_name);
if (!command) {
fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
command_name);
- return 1;
+ ret = EXIT_FAILURE;
+ goto DONE;
}
config = notmuch_config_open (local, config_file_name, command->create_config);
- if (!config)
- return 1;
+ if (!config) {
+ ret = EXIT_FAILURE;
+ goto DONE;
+ }
ret = (command->function)(config, argc - opt_index, argv + opt_index);
- notmuch_config_close (config);
+ DONE:
+ if (config)
+ notmuch_config_close (config);
talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
if (talloc_report && strcmp (talloc_report, "") != 0) {
projects / notmuch / blobdiff