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