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