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