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