git.notmuchmail.org Git - notmuch/blob - notmuch.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  * Copyright © 2009 Keith Packard
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  18  *
  19  * Authors: Carl Worth <cworth@cworth.org>
  20  *          Keith Packard <keithp@keithp.com>
  21  */
  22
  23 #include "notmuch-client.h"
  24
  25 typedef int (*command_function_t) (void *ctx, int argc, char *argv[]);
  26
  27 typedef struct command {
  28     const char *name;
  29     command_function_t function;
  30     const char *arguments;
  31     const char *summary;
  32 } command_t;
  33
  34 static int
  35 notmuch_help_command (void *ctx, int argc, char *argv[]);
  36
  37 static command_t commands[] = {
  38     { "setup", notmuch_setup_command,
  39       NULL,
  40       "Interactively setup notmuch for first use." },
  41     { "new", notmuch_new_command,
  42       "[options...]",
  43       "Find and import new messages to the notmuch database." },
  44     { "search", notmuch_search_command,
  45       "[options...] <search-terms> [...]",
  46       "Search for messages matching the given search terms." },
  47     { "show", notmuch_show_command,
  48       "<search-terms> [...]",
  49       "Show all messages matching the search terms." },
  50     { "count", notmuch_count_command,
  51       "[options...] <search-terms> [...]",
  52       "Count messages matching the search terms." },
  53     { "reply", notmuch_reply_command,
  54       "[options...] <search-terms> [...]",
  55       "Construct a reply template for a set of messages." },
  56     { "tag", notmuch_tag_command,
  57       "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
  58       "Add/remove tags for all messages matching the search terms." },
  59     { "dump", notmuch_dump_command,
  60       "[<filename>] [--] [<search-terms>]",
  61       "Create a plain-text dump of the tags for each message." },
  62     { "restore", notmuch_restore_command,
  63       "[--accumulate] [<filename>]",
  64       "Restore the tags from the given dump file (see 'dump')." },
  65     { "config", notmuch_config_command,
  66       "[get|set] <section>.<item> [value ...]",
  67       "Get or set settings in the notmuch configuration file." },
  68     { "help", notmuch_help_command,
  69       "[<command>]",
  70       "This message, or more detailed help for the named command." }
  71 };
  72
  73 static command_t *
  74 find_command (const char *name)
  75 {
  76     size_t i;
  77
  78     for (i = 0; i < ARRAY_SIZE (commands); i++)
  79         if (strcmp (name, commands[i].name) == 0)
  80             return &commands[i];
  81
  82     return NULL;
  83 }
  84
  85 int notmuch_format_version;
  86
  87 static void
  88 usage (FILE *out)
  89 {
  90     command_t *command;
  91     unsigned int i;
  92
  93     fprintf (out,
  94              "Usage: notmuch --help\n"
  95              "       notmuch --version\n"
  96              "       notmuch <command> [args...]\n");
  97     fprintf (out, "\n");
  98     fprintf (out, "The available commands are as follows:\n");
  99     fprintf (out, "\n");
 100
 101     for (i = 0; i < ARRAY_SIZE (commands); i++) {
 102         command = &commands[i];
 103
 104         fprintf (out, "  %-11s  %s\n",
 105                  command->name, command->summary);
 106     }
 107
 108     fprintf (out, "\n");
 109     fprintf (out,
 110     "Use \"notmuch help <command>\" for more details on each command\n"
 111     "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
 112 }
 113
 114 void
 115 notmuch_exit_if_unsupported_format (void)
 116 {
 117     if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
 118         fprintf (stderr, "\
 119 A caller requested output format version %d, but the installed notmuch\n\
 120 CLI only supports up to format version %d.  You may need to upgrade your\n\
 121 notmuch CLI.\n",
 122                  notmuch_format_version, NOTMUCH_FORMAT_CUR);
 123         exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
 124     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
 125         fprintf (stderr, "\
 126 A caller requested output format version %d, which is no longer supported\n\
 127 by the notmuch CLI (it requires at least version %d).  You may need to\n\
 128 upgrade your notmuch front-end.\n",
 129                  notmuch_format_version, NOTMUCH_FORMAT_MIN);
 130         exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
 131     } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
 132         /* Warn about old version requests so compatibility issues are
 133          * less likely when we drop support for a deprecated format
 134          * versions. */
 135         fprintf (stderr, "\
 136 A caller requested deprecated output format version %d, which may not\n\
 137 be supported in the future.\n", notmuch_format_version);
 138     }
 139 }
 140
 141 static void
 142 exec_man (const char *page)
 143 {
 144     if (execlp ("man", "man", page, (char *) NULL)) {
 145         perror ("exec man");
 146         exit (1);
 147     }
 148 }
 149
 150 static int
 151 notmuch_help_command (void *ctx, int argc, char *argv[])
 152 {
 153     command_t *command;
 154
 155     argc--; argv++; /* Ignore "help" */
 156
 157     if (argc == 0) {
 158         printf ("The notmuch mail system.\n\n");
 159         usage (stdout);
 160         return 0;
 161     }
 162
 163     if (strcmp (argv[0], "help") == 0) {
 164         printf ("The notmuch help system.\n\n"
 165                 "\tNotmuch uses the man command to display help. In case\n"
 166                 "\tof difficulties check that MANPATH includes the pages\n"
 167                 "\tinstalled by notmuch.\n\n"
 168                 "\tTry \"notmuch help\" for a list of topics.\n");
 169         return 0;
 170     }
 171
 172     command = find_command (argv[0]);
 173     if (command) {
 174         char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
 175         exec_man (page);
 176     }
 177
 178     if (strcmp (argv[0], "search-terms") == 0) {
 179         exec_man ("notmuch-search-terms");
 180     } else if (strcmp (argv[0], "hooks") == 0) {
 181         exec_man ("notmuch-hooks");
 182     }
 183
 184     fprintf (stderr,
 185              "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
 186              argv[0]);
 187     return 1;
 188 }
 189
 190 /* Handle the case of "notmuch" being invoked with no command
 191  * argument. For now we just call notmuch_setup_command, but we plan
 192  * to be more clever about this in the future.
 193  */
 194 static int
 195 notmuch (void *ctx)
 196 {
 197     notmuch_config_t *config;
 198     notmuch_bool_t is_new;
 199     char *db_path;
 200     struct stat st;
 201
 202     config = notmuch_config_open (ctx, NULL, &is_new);
 203
 204     /* If the user has never configured notmuch, then run
 205      * notmuch_setup_command which will give a nice welcome message,
 206      * and interactively guide the user through the configuration. */
 207     if (is_new) {
 208         notmuch_config_close (config);
 209         return notmuch_setup_command (ctx, 0, NULL);
 210     }
 211
 212     /* Notmuch is already configured, but is there a database? */
 213     db_path = talloc_asprintf (ctx, "%s/%s",
 214                                notmuch_config_get_database_path (config),
 215                                ".notmuch");
 216     if (stat (db_path, &st)) {
 217         notmuch_config_close (config);
 218         if (errno != ENOENT) {
 219             fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
 220                      db_path, strerror (errno));
 221             return 1;
 222         }
 223         printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
 224                 db_path);
 225         printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
 226                 "Note that the first run of \"notmuch new\" can take a very long time\n"
 227                 "and that the resulting database will use roughly the same amount of\n"
 228                 "storage space as the email being indexed.\n\n");
 229         return 0;
 230     }
 231
 232     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
 233             "At this point you can start exploring the functionality of notmuch by\n"
 234             "using commands such as:\n\n"
 235             "\tnotmuch search tag:inbox\n\n"
 236             "\tnotmuch search to:\"%s\"\n\n"
 237             "\tnotmuch search from:\"%s\"\n\n"
 238             "\tnotmuch search subject:\"my favorite things\"\n\n"
 239             "See \"notmuch help search\" for more details.\n\n"
 240             "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
 241             "from a search. Finally, you may want to explore using a more sophisticated\n"
 242             "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
 243             "or any other interface described at http://notmuchmail.org\n\n"
 244             "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
 245             "Have fun, and may your inbox never have much mail.\n\n",
 246             notmuch_config_get_user_name (config),
 247             notmuch_config_get_user_primary_email (config));
 248
 249     notmuch_config_close (config);
 250
 251     return 0;
 252 }
 253
 254 int
 255 main (int argc, char *argv[])
 256 {
 257     void *local;
 258     char *talloc_report;
 259     command_t *command;
 260     notmuch_bool_t print_help=FALSE, print_version=FALSE;
 261     int opt_index;
 262     int ret = 0;
 263
 264     notmuch_opt_desc_t options[] = {
 265         { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
 266         { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
 267         { 0, 0, 0, 0, 0 }
 268     };
 269
 270     talloc_enable_null_tracking ();
 271
 272     local = talloc_new (NULL);
 273
 274     g_mime_init (0);
 275     g_type_init ();
 276
 277     /* Globally default to the current output format version. */
 278     notmuch_format_version = NOTMUCH_FORMAT_CUR;
 279
 280     if (argc == 1)
 281         return notmuch (local);
 282
 283     opt_index = parse_arguments (argc, argv, options, 1);
 284     if (opt_index < 0) {
 285         /* diagnostics already printed */
 286         return 1;
 287     }
 288
 289     if (print_help)
 290         return notmuch_help_command (NULL, argc - 1, &argv[1]);
 291
 292     if (print_version) {
 293         printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
 294         return 0;
 295     }
 296
 297     command = find_command (argv[opt_index]);
 298     if (!command) {
 299         fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
 300                  argv[opt_index]);
 301         return 1;
 302     }
 303
 304     ret = (command->function)(local, argc - opt_index, argv + opt_index);
 305
 306     talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
 307     if (talloc_report && strcmp (talloc_report, "") != 0) {
 308         /* this relies on the previous call to
 309          * talloc_enable_null_tracking
 310          */
 311
 312         FILE *report = fopen (talloc_report, "w");
 313         if (report) {
 314             talloc_report_full (NULL, report);
 315         } else {
 316             ret = 1;
 317             fprintf (stderr, "ERROR: unable to write talloc log. ");
 318             perror (talloc_report);
 319         }
 320     }
 321
 322     talloc_free (local);
 323
 324     return ret;
 325 }