X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=4fc0973d3715ddd6a967d0c16f8f188b7f951c51;hp=13e2612d4fad63caa4368e6c7e128b3640e90701;hb=e13e2591470f849c86d410f50ec8103d2a5daf5b;hpb=419b88059dcaedbe104327be27b85c56e6be03c0 diff --git a/notmuch.c b/notmuch.c index 13e2612d..4fc0973d 100644 --- a/notmuch.c +++ b/notmuch.c @@ -29,291 +29,61 @@ typedef struct command { command_function_t function; const char *arguments; const char *summary; - const char *documentation; } command_t; +#define MAX_ALIAS_SUBSTITUTIONS 3 + +typedef struct alias { + const char *name; + const char *substitutions[MAX_ALIAS_SUBSTITUTIONS]; +} alias_t; + +alias_t aliases[] = { + { "part", { "show", "--format=raw"}}, + { "search-tags", {"search", "--output=tags", "*"}} +}; + static int notmuch_help_command (void *ctx, int argc, char *argv[]); -static const char search_terms_help[] = - "\tSeveral notmuch commands accept a comman syntax for search\n" - "\tterms.\n" - "\n" - "\tThe search terms can consist of free-form text (and quoted\n" - "\tphrases) which will match all messages that contain all of\n" - "\tthe given terms/phrases in the body, the subject, or any of\n" - "\tthe sender or recipient headers.\n" - "\n" - "\tAs a special case, a search string consisting of exactly a\n" - "\tsingle asterisk (\"*\") will match all messages.\n" - "\n" - "\tIn addition to free text, the following prefixes can be used\n" - "\tto force terms to match against specific portions of an email,\n" - "\t(where indicate user-supplied values):\n" - "\n" - "\t\tfrom:\n" - "\t\tto:\n" - "\t\tsubject:\n" - "\t\tattachment:\n" - "\t\ttag: (or is:)\n" - "\t\tid:\n" - "\t\tthread:\n" - "\n" - "\tThe from: prefix is used to match the name or address of\n" - "\tthe sender of an email message.\n" - "\n" - "\tThe to: prefix is used to match the names or addresses of\n" - "\tany recipient of an email message, (whether To, Cc, or Bcc).\n" - "\n" - "\tAny term prefixed with subject: will match only text from\n" - "\tthe subject of an email. Quoted phrases are supported when\n" - "\tsearching with: subject:\"this is a phrase\".\n" - "\n" - "\tFor tag: and is:, valid tag values include \"inbox\" and \"unread\"\n" - "\tby default for new messages added by \"notmuch new\" as well\n" - "\tas any other tag values added manually with \"notmuch tag\".\n" - "\n" - "\tFor id:, message ID values are the literal contents of the\n" - "\tMessage-ID: header of email messages, but without the '<','>'\n" - "\tdelimiters.\n" - "\n" - "\tThe thread: prefix can be used with the thread ID values that\n" - "\tare generated internally by notmuch (and do not appear in email\n" - "\tmessages). These thread ID values can be seen in the first\n" - "\tcolumn of output from \"notmuch search\".\n" - "\n" - "\tIn addition to individual terms, multiple terms can be\n" - "\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n" - "\tEach term in the query will be implicitly connected by a\n" - "\tlogical AND if no explicit operator is provided, (except\n" - "\tthat terms with a common prefix will be implicitly combined\n" - "\twith OR until we get Xapian defect #402 fixed).\n" - "\n" - "\tParentheses can also be used to control the combination of\n" - "\tthe Boolean operators, but will have to be protected from\n" - "\tinterpretation by the shell, (such as by putting quotation\n" - "\tmarks around any parenthesized expression).\n" - "\n" - "\tFinally, results can be restricted to only messages within a\n" - "\tparticular time range, (based on the Date: header) with:\n" - "\n" - "\t\t..\n" - "\n" - "\tEach timestamp is a number representing the number of seconds\n" - "\tsince 1970-01-01 00:00:00 UTC. This is not the most convenient\n" - "\tmeans of expressing date ranges, but until notmuch is fixed to\n" - "\taccept a more convenient form, one can use the date program to\n" - "\tconstruct timestamps. For example, with the bash shell the\n" - "\tfollowing syntax would specify a date range to return messages\n" - "\tfrom 2009-10-01 until the current time:\n" - "\n" - "\t\t$(date +%%s -d 2009-10-01)..$(date +%%s)\n\n"; - -command_t commands[] = { +static command_t commands[] = { { "setup", notmuch_setup_command, NULL, - "Interactively setup notmuch for first use.", - "\tThe setup command will prompt for your full name, your primary\n" - "\temail address, any alternate email addresses you use, and the\n" - "\tdirectory containing your email archives. Your answers will be\n" - "\twritten to a configuration file in ${NOTMUCH_CONFIG} (if set)\n" - "\tor ${HOME}/.notmuch-config.\n" - "\n" - "\tThis configuration file will be created with descriptive\n" - "\tcomments, making it easy to edit by hand later to change the\n" - "\tconfiguration. Or you can run \"notmuch setup\" again.\n" - "\n" - "\tInvoking notmuch with no command argument will run setup if\n" - "\tthe setup command has not previously been completed." }, + "Interactively setup notmuch for first use." }, { "new", notmuch_new_command, - "[--verbose]", - "Find and import new messages to the notmuch database.", - "\tScans all sub-directories of the mail directory, performing\n" - "\tfull-text indexing on new messages that are found. Each new\n" - "\tmessage will be tagged as both \"inbox\" and \"unread\".\n" - "\n" - "\tYou should run \"notmuch new\" once after first running\n" - "\t\"notmuch setup\" to create the initial database. The first\n" - "\trun may take a long time if you have a significant amount of\n" - "\tmail (several hundred thousand messages or more).\n" - "\n" - "\tSubsequently, you should run \"notmuch new\" whenever new mail\n" - "\tis delivered and you wish to incorporate it into the database.\n" - "\tThese subsequent runs will be much quicker than the initial run.\n" - "\n" - "\tSupported options for new include:\n" - "\n" - "\t--verbose\n" - "\n" - "\t\tVerbose operation. Shows paths of message files as\n" - "\t\tthey are being indexed.\n" - "\n" - "\tInvoking notmuch with no command argument will run new if\n" - "\tthe setup command has previously been completed, but new has\n" - "\tnot previously been run." }, + "[options...]", + "Find and import new messages to the notmuch database." }, { "search", notmuch_search_command, "[options...] [...]", - "Search for messages matching the given search terms.", - "\tNote that the individual mail messages will be matched\n" - "\tagainst the search terms, but the results will be the\n" - "\tthreads (one per line) containing the matched messages.\n" - "\n" - "\tSupported options for search include:\n" - "\n" - "\t--format=(json|text)\n" - "\n" - "\t\tPresents the results in either JSON or\n" - "\t\tplain-text (default)\n" - "\n" - "\t--sort=(newest-first|oldest-first)\n" - "\n" - "\t\tPresent results in either chronological order\n" - "\t\t(oldest-first) or reverse chronological order\n" - "\t\t(newest-first), which is the default.\n" - "\n" - "\tSee \"notmuch help search-terms\" for details of the search\n" - "\tterms syntax." }, + "Search for messages matching the given search terms." }, { "show", notmuch_show_command, " [...]", - "Show all messages matching the search terms.", - "\tThe messages are grouped and sorted based on the threading\n" - "\t(all replies to a particular message appear immediately\n" - "\tafter that message in date order).\n" - "\n" - "\tSupported options for show include:\n" - "\n" - "\t--entire-thread\n" - "\n" - "\t\tBy default only those messages that match the\n" - "\t\tsearch terms will be displayed. With this option,\n" - "\t\tall messages in the same thread as any matched\n" - "\t\tmessage will be displayed.\n" - "\n" - "\t--format=(json|text)\n" - "\n" - "\t\ttext\t(default)\n" - "\n" - "\t\tThe plain-text has all text-content MIME parts decoded.\n" - "\t\tVarious components in the output, ('message', 'header',\n" - "\t\t'body', 'attachment', and MIME 'part') are delimited by\n" - "\t\teasily-parsed markers. Each marker consists of a Control-L\n" - "\t\tcharacter (ASCII decimal 12), the name of the marker, and\n" - "\t\tthen either an opening or closing brace, '{' or '}' to\n" - "\t\teither open or close the component.\n" - "\n" - "\t\tjson\n" - "\n" - "\t\tFormat output as Javascript Object Notation (JSON).\n" - "\t\tJSON output always includes all messages in a matching,\n" - "\t\tthread i.e. '--format=json' implies '--entire-thread'\n" - "\n" - "\tA common use of \"notmuch show\" is to display a single\n" - "\tthread of email messages. For this, use a search term of\n" - "\t\"thread:\" as can be seen in the first column\n" - "\tof output from the \"notmuch search\" command.\n" - "\n" - "\tSee \"notmuch help search-terms\" for details of the search\n" - "\tterms syntax." }, + "Show all messages matching the search terms." }, { "count", notmuch_count_command, - " [...]", - "Count messages matching the search terms.", - "\tThe number of matching messages is output to stdout.\n" - "\n" - "\tWith no search terms, a count of all messages in the database\n" - "\twill be displayed.\n" - "\n" - "\tSee \"notmuch help search-terms\" for details of the search\n" - "\tterms syntax." }, + "[options...] [...]", + "Count messages matching the search terms." }, { "reply", notmuch_reply_command, "[options...] [...]", - "Construct a reply template for a set of messages.", - "\tConstructs a new message as a reply to a set of existing\n" - "\tmessages. The Reply-To: header (if any, otherwise From:) is\n" - "\tused for the To: address. The To: and Cc: headers are copied,\n" - "\tbut not including any of the user's configured addresses.\n" - "\n" - "\tA suitable subject is constructed. The In-Reply-to: and\n" - "\tReferences: headers are set appropriately, and the content\n" - "\tof the original messages is quoted and included in the body\n" - "\t(unless --format=headers-only is given).\n" - "\n" - "\tThe resulting message template is output to stdout.\n" - "\n" - "\tSupported options for reply include:\n" - "\n" - "\t--format=(default|headers-only)\n" - "\n" - "\t\tdefault:\n" - "\t\t\tIncludes subject and quoted message body.\n" - "\n" - "\t\theaders-only:\n" - "\t\t\tOnly produces In-Reply-To, References, To\n" - "\t\t\tCc, and Bcc headers.\n" - "\n" - "\tSee \"notmuch help search-terms\" for details of the search\n" - "\tterms syntax." }, + "Construct a reply template for a set of messages." }, { "tag", notmuch_tag_command, - "+|- [...] [--] [...]", - "Add/remove tags for all messages matching the search terms.", - "\tThe search terms are handled exactly as in 'search' so one\n" - "\tcan use that command first to see what will be modified.\n" - "\n" - "\tTags prefixed by '+' are added while those prefixed by\n" - "\t'-' are removed. For each message, tag removal is performed\n" - "\tbefore tag addition.\n" - "\n" - "\tThe beginning of is recognized by the first\n" - "\targument that begins with neither '+' nor '-'. Support for\n" - "\tan initial search term beginning with '+' or '-' is provided\n" - "\tby allowing the user to specify a \"--\" argument to separate\n" - "\tthe tags from the search terms.\n" - "\n" - "\tSee \"notmuch help search-terms\" for details of the search\n" - "\tterms syntax." }, + "+|- [...] [--] [...]" , + "Add/remove tags for all messages matching the search terms." }, { "dump", notmuch_dump_command, - "[]", - "Create a plain-text dump of the tags for each message.", - "\tOutput is to the given filename, if any, or to stdout.\n" - "\tThese tags are the only data in the notmuch database\n" - "\tthat can't be recreated from the messages themselves.\n" - "\tThe output of notmuch dump is therefore the only\n" - "\tcritical thing to backup (and much more friendly to\n" - "\tincremental backup than the native database files.)" }, + "[] [--] []", + "Create a plain-text dump of the tags for each message." }, { "restore", notmuch_restore_command, - "", - "Restore the tags from the given dump file (see 'dump').", - "\tNote: The dump file format is specifically chosen to be\n" - "\tcompatible with the format of files produced by sup-dump.\n" - "\tSo if you've previously been using sup for mail, then the\n" - "\t\"notmuch restore\" command provides you a way to import\n" - "\tall of your tags (or labels as sup calls them)." }, - { "search-tags", notmuch_search_tags_command, - "[ [...] ]", - "List all tags found in the database or matching messages.", - "\tRun this command without any search-term(s) to obtain a list\n" - "\tof all tags found in the database. If you provide one or more\n" - "\tsearch-terms as argument(s) then the resulting list will\n" - "\tcontain tags only from messages that match the search-term(s).\n" - "\n" - "\tIn both cases the list will be alphabetically sorted." }, - { "part", notmuch_part_command, - "--part= ", - "Output a single MIME part of a message.", - "\tA single decoded MIME part, with no encoding or framing,\n" - "\tis output to stdout. The search terms must match only a single\n" - "\tmessage, otherwise this command will fail.\n" - "\n" - "\tThe part number should match the part \"id\" field output\n" - "\tby the \"--format=json\" option of \"notmuch show\". If the\n" - "\tmessage specified by the search terms does not include a\n" - "\tpart with the specified \"id\" there will be no output." }, + "[--accumulate] []", + "Restore the tags from the given dump file (see 'dump')." }, + { "config", notmuch_config_command, + "[get|set]
. [value ...]", + "Get or set settings in the notmuch configuration file." }, { "help", notmuch_help_command, "[]", - "This message, or more detailed help for the named command.", - "\tExcept in this case, where there's not much more detailed\n" - "\thelp available." } + "This message, or more detailed help for the named command." } }; +int notmuch_format_version; + static void usage (FILE *out) { @@ -341,49 +111,78 @@ usage (FILE *out) "and \"notmuch help search-terms\" for the common search-terms syntax.\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_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); + } +} + +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[]) +notmuch_help_command (void *ctx, int argc, char *argv[]) { command_t *command; unsigned int i; + argc--; argv++; /* Ignore "help" */ + if (argc == 0) { printf ("The notmuch mail system.\n\n"); usage (stdout); return 0; } + 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; + } + 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 ("%s %s\n\n\t%s\n\n%s\n\n", - command->name, command->arguments, - command->summary, command->documentation); - else - printf ("%s\t%s\n\n%s\n\n", command->name, - command->summary, command->documentation); - return 0; + char *page = talloc_asprintf (ctx, "notmuch-%s", command->name); + exec_man (page); } } 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]; - - 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; + exec_man ("notmuch-search-terms"); + } else if (strcmp (argv[0], "hooks") == 0) { + exec_man ("notmuch-hooks"); } fprintf (stderr, @@ -461,28 +260,90 @@ main (int argc, char *argv[]) { void *local; command_t *command; - unsigned int i; + alias_t *alias; + unsigned int i, j; + const char **argv_local; + + talloc_enable_null_tracking (); local = talloc_new (NULL); g_mime_init (0); + g_type_init (); + + /* Globally default to the current output format version. */ + notmuch_format_version = NOTMUCH_FORMAT_CUR; if (argc == 1) return notmuch (local); - if (STRNCMP_LITERAL (argv[1], "--help") == 0) - return notmuch_help_command (NULL, 0, NULL); + if (strcmp (argv[1], "--help") == 0) + return notmuch_help_command (NULL, argc - 1, &argv[1]); - if (STRNCMP_LITERAL (argv[1], "--version") == 0) { + if (strcmp (argv[1], "--version") == 0) { printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); return 0; } + for (i = 0; i < ARRAY_SIZE (aliases); i++) { + alias = &aliases[i]; + + if (strcmp (argv[1], alias->name) == 0) + { + int substitutions; + + argv_local = talloc_size (local, sizeof (char *) * + (argc + MAX_ALIAS_SUBSTITUTIONS - 1)); + if (argv_local == NULL) { + fprintf (stderr, "Out of memory.\n"); + return 1; + } + + /* 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; + + /* 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]; + } + + argc += substitutions - 1; + argv = (char **) argv_local; + } + } + for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; - if (strcmp (argv[1], command->name) == 0) - return (command->function) (local, argc - 2, &argv[2]); + if (strcmp (argv[1], command->name) == 0) { + int ret; + char *talloc_report; + + ret = (command->function)(local, argc - 1, &argv[1]); + + /* in the future support for this environment variable may + * be supplemented or replaced by command line arguments + * --leak-report and/or --leak-report-full */ + + talloc_report = getenv ("NOTMUCH_TALLOC_REPORT"); + + /* this relies on the previous call to + * talloc_enable_null_tracking */ + + if (talloc_report && strcmp (talloc_report, "") != 0) { + FILE *report = fopen (talloc_report, "w"); + talloc_report_full (NULL, report); + } + + return ret; + } } fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",