* 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/ .
*
* Authors: Carl Worth <cworth@cworth.org>
* Keith Packard <keithp@keithp.com>
#include "notmuch-client.h"
-typedef int (*command_function_t) (void *ctx, int argc, char *argv[]);
+/*
+ * Notmuch subcommand hook.
+ *
+ * The return value will be used as notmuch exit status code,
+ * preferably EXIT_SUCCESS or EXIT_FAILURE.
+ *
+ * Each subcommand should be passed either a config object, or an open
+ * database
+ */
+typedef int (*command_function_t) (notmuch_database_t *notmuch, int argc, char *argv[]);
typedef struct command {
const char *name;
command_function_t function;
- const char *arguments;
+ notmuch_command_mode_t mode;
const char *summary;
- const char *documentation;
} command_t;
static int
-notmuch_help_command (void *ctx, int argc, char *argv[]);
-
-static const char search_terms_help[] =
- "\t\tSeveral notmuch commands accept a comman syntax for search\n"
- "\t\tterms.\n"
- "\n"
- "\t\tThe search terms can consist of free-form text (and quoted\n"
- "\t\tphrases) which will match all messages that contain all of\n"
- "\t\tthe given terms/phrases in the body, the subject, or any of\n"
- "\t\tthe sender or recipient headers.\n"
- "\n"
- "\t\tIn addition to free text, the following prefixes can be used\n"
- "\t\tto force terms to match against specific portions of an email,\n"
- "\t\t(where <brackets> indicate user-supplied 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\tattachment:<word>\n"
- "\t\t\ttag:<tag> (or is:<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\tFor tag: and is:, valid tag values include \"inbox\" and \"unread\"\n"
- "\t\tby default for new messages added by \"notmuch new\" as well\n"
- "\t\tas any other tag values added manually with \"notmuch tag\".\n"
- "\n"
- "\t\tFor id:, message ID values are the literal contents of the\n"
- "\t\tMessage-ID: header of email messages, but without the '<','>'\n"
- "\t\tdelimiters.\n"
- "\n"
- "\t\tThe thread: prefix can be used with the thread ID values that\n"
- "\t\tare generated internally by notmuch (and do not appear in email\n"
- "\t\tmessages). These thread ID values can be seen in the first\n"
- "\t\tcolumn of output from \"notmuch search\".\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).\n"
- "\n"
- "\t\tFinally, results can be restricted to only messages within a\n"
- "\t\tparticular time range, (based on the Date: header) with:\n"
- "\n"
- "\t\t\t<intial-timestamp>..<final-timestamp>\n"
- "\n"
- "\t\tEach timestamp is a number representing the number of seconds\n"
- "\t\tsince 1970-01-01 00:00:00 UTC. This is not the most convenient\n"
- "\t\tmeans of expressing date ranges, but until notmuch is fixed to\n"
- "\t\taccept a more convenient form, one can use the date program to\n"
- "\t\tconstruct timestamps. For example, with the bash shell the\n"
- "\t\tfollowing syntax would specify a date range to return messages\n"
- "\t\tfrom 2009-10-01 until the current time:\n"
- "\n"
- "\t\t\t$(date +%%s -d 2009-10-01)..$(date +%%s)\n\n";
-
-command_t commands[] = {
- { "setup", notmuch_setup_command,
- NULL,
- "Interactively setup notmuch for first use.",
- "\t\tThe setup command will prompt for your full name, your primary\n"
- "\t\temail address, any alternate email addresses you use, and the\n"
- "\t\tdirectory containing your email archives. Your answers will be\n"
- "\t\twritten to a configuration file in ${NOTMUCH_CONFIG} (if set)\n"
- "\t\tor ${HOME}/.notmuch-config.\n"
- "\n"
- "\t\tThis configuration file will be created with descriptive\n"
- "\t\tcomments, making it easy to edit by hand later to change the\n"
- "\t\tconfiguration. Or you can run \"notmuch setup\" again.\n"
- "\n"
- "\t\tInvoking notmuch with no command argument will run setup if\n"
- "\t\tthe setup command has not previously been completed." },
+notmuch_help_command (notmuch_database_t *notmuch, int argc, char *argv[]);
+
+static int
+notmuch_command (notmuch_database_t *notmuch, int argc, char *argv[]);
+
+static int
+_help_for (const char *topic);
+
+static void
+notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
+
+static bool print_version = false, print_help = false;
+static const char *notmuch_requested_db_uuid = NULL;
+static int query_syntax = NOTMUCH_QUERY_SYNTAX_XAPIAN;
+
+const notmuch_opt_desc_t notmuch_shared_options [] = {
+ { .opt_bool = &print_version, .name = "version" },
+ { .opt_bool = &print_help, .name = "help" },
+ { .opt_string = ¬much_requested_db_uuid, .name = "uuid" },
+ { .opt_keyword = &query_syntax, .name = "query", .keywords =
+ (notmuch_keyword_t []){ { "infix", NOTMUCH_QUERY_SYNTAX_XAPIAN },
+ { "sexp", NOTMUCH_QUERY_SYNTAX_SEXP },
+ { 0, 0 } } },
+
+ { }
+};
+
+notmuch_query_syntax_t
+shared_option_query_syntax ()
+{
+ return query_syntax;
+}
+
+/* any subcommand wanting to support these options should call
+ * inherit notmuch_shared_options and call
+ * notmuch_process_shared_options (notmuch, subcommand_name);
+ * with notmuch = an open database, or NULL.
+ */
+void
+notmuch_process_shared_options (notmuch_database_t *notmuch, 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);
+ }
+
+ if (notmuch) {
+ notmuch_exit_if_unmatched_db_uuid (notmuch);
+ } else {
+ if (notmuch_requested_db_uuid)
+ fprintf (stderr, "Warning: ignoring --uuid=%s\n",
+ notmuch_requested_db_uuid);
+ }
+}
+
+/* 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[] = {
+ { .opt_inherit = notmuch_shared_options },
+ { }
+ };
+
+ 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 (NULL, subcommand_name);
+ return opt_index;
+}
+
+
+struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
+const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
+ { .opt_keyword = &indexing_cli_choices.decrypt_policy,
+ .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
+ (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
+ { "true", NOTMUCH_DECRYPT_TRUE },
+ { "auto", NOTMUCH_DECRYPT_AUTO },
+ { "nostash", NOTMUCH_DECRYPT_NOSTASH },
+ { 0, 0 } },
+ .name = "decrypt" },
+ { }
+};
+
+
+notmuch_status_t
+notmuch_process_shared_indexing_options (notmuch_indexopts_t *opts)
+{
+ if (opts == NULL)
+ return NOTMUCH_STATUS_NULL_POINTER;
+
+ if (indexing_cli_choices.decrypt_policy_set) {
+ notmuch_status_t status;
+ status = notmuch_indexopts_set_decrypt_policy (opts,
+ indexing_cli_choices.decrypt_policy);
+ if (status != NOTMUCH_STATUS_SUCCESS) {
+ fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
+ indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
+ return status;
+ }
+ }
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
+
+static const command_t commands[] = {
+ { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
+ "Notmuch main command." },
+ { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
+ "Interactively set up notmuch for first use." },
{ "new", notmuch_new_command,
- "[--verbose]",
- "\t\tFind and import new messages to the notmuch database.",
- "\t\tScans all sub-directories of the mail directory, performing\n"
- "\t\tfull-text indexing on new messages that are found. Each new\n"
- "\t\tmessage will be tagged as both \"inbox\" and \"unread\".\n"
- "\n"
- "\t\tYou should run \"notmuch new\" once after first running\n"
- "\t\t\"notmuch setup\" to create the initial database. The first\n"
- "\t\trun may take a long time if you have a significant amount of\n"
- "\t\tmail (several hundred thousand messages or more).\n"
- "\n"
- "\t\tSubsequently, you should run \"notmuch new\" whenever new mail\n"
- "\t\tis delivered and you wish to incorporate it into the database.\n"
- "\t\tThese subsequent runs will be much quicker than the initial run.\n"
- "\n"
- "\t\tSupported options for new include:\n"
- "\n"
- "\t\t--verbose\n"
- "\n"
- "\t\t\tVerbose operation. Shows paths of message files as\n"
- "\t\t\tthey are being indexed.\n"
- "\n"
- "\t\tInvoking notmuch with no command argument will run new if\n"
- "\t\tthe setup command has previously been completed, but new has\n"
- "\t\tnot previously been run." },
- { "search", notmuch_search_command,
- "[options...] <search-terms> [...]",
- "\t\tSearch for messages 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 (one per line) containing the matched messages.\n"
- "\n"
- "\t\tSupported options for search include:\n"
- "\n"
- "\t\t--format=(json|text)\n"
- "\n"
- "\t\t\tPresents the results in either JSON or\n"
- "\t\t\tplain-text (default)\n"
- "\n"
- "\t\t--sort=(newest-first|oldest-first)\n"
- "\n"
- "\t\t\tPresent results in either chronological order\n"
- "\t\t\t(oldest-first) or reverse chronological order\n"
- "\t\t\t(newest-first), which is the default.\n"
- "\n"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
- { "show", notmuch_show_command,
- "<search-terms> [...]",
- "\t\tShow all messages matching the search terms.",
- "\t\tThe messages are grouped and sorted based on the threading\n"
- "\t\t(all replies to a particular message appear immediately\n"
- "\t\tafter that message in date order).\n"
- "\n"
- "\t\tSupported options for show include:\n"
- "\n"
- "\t\t--entire-thread\n"
- "\n"
- "\t\t\tBy default only those messages that match the\n"
- "\t\t\tsearch terms will be displayed. With this option,\n"
- "\t\t\tall messages in the same thread as any matched\n"
- "\t\t\tmessage will be displayed.\n"
- "\n"
- "\t\t--format=(json|text)\n"
- "\n"
- "\t\t\ttext\t(default)\n"
- "\n"
- "\t\t\tThe plain-text has all text-content MIME parts decoded.\n"
- "\t\t\tVarious components in the output, ('message', 'header',\n"
- "\t\t\t'body', 'attachment', and MIME 'part') are delimited by\n"
- "\t\t\teasily-parsed markers. Each marker consists of a Control-L\n"
- "\t\t\tcharacter (ASCII decimal 12), the name of the marker, and\n"
- "\t\t\tthen either an opening or closing brace, '{' or '}' to\n"
- "\t\t\teither open or close the component.\n"
- "\n"
- "\t\t\tjson\n"
- "\n"
- "\t\t\tFormat output as Javascript Object Notation (JSON).\n"
- "\t\t\tJSON output always includes all messages in a matching,\n"
- "\t\t\tthread i.e. '--output=json' implies '--entire-thread'\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\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
- { "count", notmuch_count_command,
- "<search-terms> [...]",
- "\t\tCount messages matching the search terms.",
- "\t\tThe number of matching messages is output to stdout.\n"
- "\n"
- "\t\tA common use of \"notmuch count\" is to display the count\n"
- "\t\tof messages matching both a specific tag and either inbox\n"
- "\t\tor unread\n"
- "\n"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
- { "reply", notmuch_reply_command,
- "[options...] <search-terms> [...]",
- "\t\tConstruct a reply template for a set of messages.",
- "\t\tConstructs a new message as a reply to a set of existing\n"
- "\t\tmessages. The Reply-To: header (if any, otherwise From:) is\n"
- "\t\tused for the To: address. The To: and Cc: headers are copied,\n"
- "\t\tbut not including any of the user's configured addresses.\n"
- "\n"
- "\t\tA suitable subject is constructed. The In-Reply-to: and\n"
- "\t\tReferences: headers are set appropriately, and the content\n"
- "\t\tof the original messages is quoted and included in the body\n"
- "\t\t(unless --format=headers-only is given).\n"
- "\n"
- "\t\tThe resulting message template is output to stdout.\n"
- "\n"
- "\t\tSupported options for reply include:\n"
- "\n"
- "\t\t--format=(default|headers-only)\n"
- "\n"
- "\t\t\tdefault:\n"
- "\t\t\t\tIncludes subject and quoted message body.\n"
- "\n"
- "\t\t\theaders-only:\n"
- "\t\t\t\tOnly produces In-Reply-To, References, To\n"
- "\t\t\t\tCc, and Bcc headers.\n"
- "\n"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
- { "tag", notmuch_tag_command,
- "+<tag>|-<tag> [...] [--] <search-terms> [...]",
- "\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\n"
- "\t\t'-' are removed. For each message, tag removal is performed\n"
- "\t\tbefore 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\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
- { "dump", notmuch_dump_command,
- "[<filename>]",
- "\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", notmuch_restore_command,
- "<filename>",
- "\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)." },
- { "search-tags", notmuch_search_tags_command,
- "[<search-terms> [...] ]",
- "\t\tList all tags found in the database or matching messages.",
- "\t\tRun this command without any search-term(s) to obtain a list\n"
- "\t\tof all tags found in the database. If you provide one or more\n"
- "\t\tsearch-terms as argument(s) then the resulting list will\n"
- "\t\tcontain tags only from messages that match the search-term(s).\n"
- "\n"
- "\t\tIn both cases the list will be alphabetically sorted." },
- { "help", notmuch_help_command,
- "[<command>]",
- "\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." }
+ NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
+ NOTMUCH_COMMAND_DATABASE_CREATE,
+ "Find and import new messages to the notmuch database." },
+ { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
+ NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Add a new message into the maildir and notmuch database." },
+ { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
+ "Search for messages matching the given search terms." },
+ { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
+ "Get addresses from messages matching the given search terms." },
+ { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
+ "Show all messages matching the search terms." },
+ { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
+ "Count messages matching the search terms." },
+ { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
+ "Construct a reply template for a set of messages." },
+ { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Add/remove tags for all messages matching the search terms." },
+ { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Create a plain-text dump of the tags for each message." },
+ { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
+ NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Restore the tags from the given dump file (see 'dump')." },
+ { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
+ NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Compact the notmuch database." },
+ { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
+ NOTMUCH_COMMAND_DATABASE_WRITE,
+ "Re-index all messages matching the search terms." },
+ { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_LOAD,
+ "Get or set settings in the notmuch configuration file." },
+#if WITH_EMACS
+ { "emacs-mua", NULL, 0,
+ "send mail with notmuch and emacs." },
+#endif
+ { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* 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 const help_topic_t help_topics[] = {
+ { "hooks",
+ "Hooks that will be run before or after certain commands." },
+ { "properties",
+ "Message property conventions and documentation." },
+ { "search-terms",
+ "Common infix search term syntax." },
+ { "sexp-queries",
+ "Common s-expression search term syntax." },
};
+static const command_t *
+find_command (const char *name)
+{
+ size_t i;
+
+ 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 NULL;
+}
+
+int notmuch_format_version;
+
static void
usage (FILE *out)
{
- command_t *command;
+ const command_t *command;
+ const help_topic_t *topic;
unsigned int i;
fprintf (out,
" notmuch --version\n"
" notmuch <command> [args...]\n");
fprintf (out, "\n");
- fprintf (out, "Where <command> and [args...] are as follows:\n");
+ fprintf (out, "The available commands are as follows:\n");
fprintf (out, "\n");
for (i = 0; i < ARRAY_SIZE (commands); i++) {
command = &commands[i];
- if (command->arguments)
- fprintf (out, "\t%s\t%s\n\n%s\n\n",
- command->name, command->arguments, command->summary);
- else
- fprintf (out, "\t%s\t%s\n\n",
- command->name, command->summary);
+ if (command->name)
+ 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
+notmuch_exit_if_unsupported_format (void)
+{
+ 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);
+ }
+}
+
+static 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)
+{
+ if (execlp ("man", "man", page, (char *) NULL)) {
+ perror ("exec man");
+ exit (1);
+ }
}
static int
-notmuch_help_command (unused (void *ctx), int argc, char *argv[])
+_help_for (const char *topic_name)
{
- command_t *command;
- unsigned int i;
+ char *page;
- if (argc == 0) {
+ if (! topic_name) {
printf ("The notmuch mail system.\n\n");
usage (stdout);
- return 0;
+ return EXIT_SUCCESS;
}
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
-
- if (strcmp (argv[0], command->name) == 0) {
- printf ("Help for \"notmuch %s\":\n\n", argv[0]);
- if (command->arguments)
- printf ("\t%s\t%s\n\n%s\n\n%s\n\n",
- command->name, command->arguments,
- command->summary, command->documentation);
- else
- printf ("\t%s\t%s\n\n%s\n\n", command->name,
- command->summary, command->documentation);
- return 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 EXIT_SUCCESS;
}
- if (strcmp (argv[0], "search-terms") == 0) {
- printf ("Help for <%s>\n\n", argv[0]);
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ page = talloc_asprintf (NULL, "notmuch-%s", topic_name);
+ exec_man (page);
- if (command->arguments &&
- strstr (command->arguments, "search-terms"))
- {
- printf ("\t%s\t%s\n",
- command->name, command->arguments);
- }
- }
- printf ("\n");
- printf (search_terms_help);
- return 0;
+ return EXIT_FAILURE;
+}
+
+static int
+notmuch_help_command (unused(notmuch_database_t *notmuch), 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);
}
- fprintf (stderr,
- "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
- argv[0]);
- return 1;
+ return _help_for (argv[0]);
}
/* Handle the case of "notmuch" being invoked with no command
* to be more clever about this in the future.
*/
static int
-notmuch (void *ctx)
+notmuch_command (notmuch_database_t *notmuch,
+ unused(int argc), unused(char **argv))
{
- notmuch_config_t *config;
- notmuch_bool_t is_new;
- char *db_path;
- struct stat st;
- config = notmuch_config_open (ctx, NULL, &is_new);
+ const char *config_path;
- /* If the user has never configured notmuch, then run
+ /* If the user has not created a configuration file, 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);
- }
-
- /* 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);
+ config_path = notmuch_config_path (notmuch);
+ if (access (config_path, R_OK | F_OK) == -1) {
if (errno != ENOENT) {
- fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
- db_path, strerror (errno));
- return 1;
+ fprintf (stderr, "Error: %s config file access failed: %s\n", config_path,
+ strerror (errno));
+ return EXIT_FAILURE;
+ } else {
+ return notmuch_setup_command (notmuch, 0, NULL);
}
- 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;
}
printf ("Notmuch is configured and appears to have a database. Excellent!\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"
+ "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));
+ notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME),
+ notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
- notmuch_config_close (config);
+ return EXIT_SUCCESS;
+}
+
+/*
+ * 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 bool
+try_external_command (const char *config_file_name, char *argv[])
+{
+ char *old_argv0 = argv[0];
+ bool ret = true;
+
+ if (config_file_name) {
+ if (setenv ("NOTMUCH_CONFIG", config_file_name, 1)) {
+ perror ("setenv");
+ exit (1);
+ }
+ }
- return 0;
+ argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
+
+ /*
+ * 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;
+ }
+
+ talloc_free (argv[0]);
+ argv[0] = old_argv0;
+
+ return ret;
}
int
main (int argc, char *argv[])
{
void *local;
- command_t *command;
- unsigned int i;
+ char *talloc_report;
+ const char *command_name = NULL;
+ const command_t *command;
+ const char *config_file_name = NULL;
+ notmuch_database_t *notmuch = NULL;
+ int opt_index;
+ int ret = EXIT_SUCCESS;
+
+ notmuch_opt_desc_t options[] = {
+ { .opt_string = &config_file_name, .name = "config", .allow_empty = TRUE },
+ { .opt_inherit = notmuch_shared_options },
+ { }
+ };
+
+ notmuch_client_init ();
local = talloc_new (NULL);
- g_mime_init (0);
+ /* Globally default to the current output format version. */
+ notmuch_format_version = NOTMUCH_FORMAT_CUR;
- if (argc == 1)
- return notmuch (local);
+ opt_index = parse_arguments (argc, argv, options, 1);
+ if (opt_index < 0) {
+ ret = EXIT_FAILURE;
+ goto DONE;
+ }
+
+ if (opt_index < argc)
+ command_name = argv[opt_index];
- if (STRNCMP_LITERAL (argv[1], "--help") == 0)
- return notmuch_help_command (NULL, 0, NULL);
+ notmuch_process_shared_options (NULL, command_name);
- if (STRNCMP_LITERAL (argv[1], "--version") == 0) {
- printf ("notmuch version " STRINGIFY(NOTMUCH_VERSION) "\n");
- return 0;
+ command = find_command (command_name);
+ /* if command->function is NULL, try external command */
+ if (! command || ! command->function) {
+ /* This won't return if the external command is found. */
+ if (try_external_command (config_file_name, argv + opt_index))
+ fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+ command_name);
+ ret = EXIT_FAILURE;
+ goto DONE;
}
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
+ char *status_string = NULL;
+ notmuch_database_mode_t mode;
+ notmuch_status_t status;
+
+ if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
+ command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
+ mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
+ else
+ mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
+
+ if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
+ status = notmuch_database_create_with_config (NULL,
+ config_file_name,
+ NULL,
+ ¬much,
+ &status_string);
+ if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
+ if (status_string) {
+ fputs (status_string, stderr);
+ free (status_string);
+ }
+
+ if (status == NOTMUCH_STATUS_NO_CONFIG)
+ fputs ("Try running 'notmuch setup' to create a configuration.\n", stderr);
+
+ return EXIT_FAILURE;
+ }
+ }
- if (strcmp (argv[1], command->name) == 0)
- return (command->function) (local, argc - 2, &argv[2]);
+ if (notmuch == NULL) {
+ status = notmuch_database_open_with_config (NULL,
+ mode,
+ config_file_name,
+ NULL,
+ ¬much,
+ &status_string);
+ if (status) {
+ if (status_string) {
+ fputs (status_string, stderr);
+ free (status_string);
+ }
+
+ return EXIT_FAILURE;
+ }
+ }
}
- fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
- argv[1]);
+ if (command->mode & NOTMUCH_COMMAND_CONFIG_LOAD) {
+ char *status_string = NULL;
+ notmuch_status_t status;
+ status = notmuch_database_load_config (NULL,
+ config_file_name,
+ NULL,
+ ¬much,
+ &status_string);
+ switch (status) {
+ case NOTMUCH_STATUS_NO_CONFIG:
+ if (! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
+ fputs ("Try running 'notmuch setup' to create a configuration.\n", stderr);
+ goto DONE;
+ }
+ break;
+ case NOTMUCH_STATUS_NO_DATABASE:
+ if (! command_name) {
+ printf ("Notmuch is configured, but no database was found.\n");
+ printf ("You probably want to run \"notmuch new\" now to create a 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");
+ status = NOTMUCH_STATUS_SUCCESS;
+ goto DONE;
+ }
+ break;
+ case NOTMUCH_STATUS_SUCCESS:
+ break;
+ default:
+ goto DONE;
+ }
+
+ }
+
+ ret = (command->function)(notmuch, argc - opt_index, argv + opt_index);
+
+ DONE:
+ talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
+ if (talloc_report && strcmp (talloc_report, "") != 0) {
+ /* this relies on the previous call to
+ * talloc_enable_null_tracking
+ */
+
+ FILE *report = fopen (talloc_report, "a");
+ if (report) {
+ talloc_report_full (NULL, report);
+ } else {
+ ret = 1;
+ fprintf (stderr, "ERROR: unable to write talloc log. ");
+ perror (talloc_report);
+ }
+ }
talloc_free (local);
- return 1;
+ return ret;
}