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