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