notmuch/notmuch.c

/* notmuch - Not much of an email program, (just index and search)
 *
 * Copyright © 2009 Carl Worth
 * Copyright © 2009 Keith Packard
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see https://www.gnu.org/licenses/ .
 *
 * Authors: Carl Worth <cworth@cworth.org>
 *	    Keith Packard <keithp@keithp.com>
 */

#include "notmuch-client.h"

/*
 * Notmuch subcommand hook.
 *
 * The return value will be used as notmuch exit status code,
 * preferably EXIT_SUCCESS or EXIT_FAILURE.
 *
 * Each subcommand should be passed either a config object, or an open
 * database
 */
typedef int (*command_function_t) (notmuch_database_t *notmuch, int argc, char *argv[]);

typedef struct command {
    const char *name;
    command_function_t function;
    notmuch_command_mode_t mode;
    const char *summary;
} command_t;

static int
notmuch_help_command (notmuch_database_t *notmuch, int argc, char *argv[]);

static int
notmuch_command (notmuch_database_t *notmuch, int argc, char *argv[]);

static int
_help_for (const char *topic);

static void
notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);

static bool print_version = false, print_help = false;
static const char *notmuch_requested_db_uuid = NULL;

const notmuch_opt_desc_t notmuch_shared_options [] = {
    { .opt_bool = &print_version, .name = "version" },
    { .opt_bool = &print_help, .name = "help" },
    { .opt_string = &notmuch_requested_db_uuid, .name = "uuid" },
    { }
};

/* any subcommand wanting to support these options should call
 * inherit notmuch_shared_options and call
 * notmuch_process_shared_options (notmuch, subcommand_name);
 * with notmuch = an open database, or NULL.
 */
void
notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name)
{
    if (print_version) {
	printf ("notmuch " STRINGIFY (NOTMUCH_VERSION) "\n");
	exit (EXIT_SUCCESS);
    }

    if (print_help) {
	int ret = _help_for (subcommand_name);
	exit (ret);
    }

    if (notmuch) {
	notmuch_exit_if_unmatched_db_uuid (notmuch);
    } else {
	if (notmuch_requested_db_uuid)
	    fprintf (stderr, "Warning: ignoring --uuid=%s\n",
		     notmuch_requested_db_uuid);
    }
}

/* This is suitable for subcommands that do not actually open the
 * database.
 */
int
notmuch_minimal_options (const char *subcommand_name,
			 int argc, char **argv)
{
    int opt_index;

    notmuch_opt_desc_t options[] = {
	{ .opt_inherit = notmuch_shared_options },
	{ }
    };

    opt_index = parse_arguments (argc, argv, options, 1);

    if (opt_index < 0)
	return -1;

    /* We can't use argv here as it is sometimes NULL */
    notmuch_process_shared_options (NULL, subcommand_name);
    return opt_index;
}


struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
    { .opt_keyword = &indexing_cli_choices.decrypt_policy,
      .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
	  (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
				  { "true", NOTMUCH_DECRYPT_TRUE },
				  { "auto", NOTMUCH_DECRYPT_AUTO },
				  { "nostash", NOTMUCH_DECRYPT_NOSTASH },
				  { 0, 0 } },
      .name = "decrypt" },
    { }
};


notmuch_status_t
notmuch_process_shared_indexing_options (notmuch_database_t *notmuch)
{
    if (indexing_cli_choices.opts == NULL)
	indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
    if (indexing_cli_choices.decrypt_policy_set) {
	notmuch_status_t status;
	if (indexing_cli_choices.opts == NULL)
	    return NOTMUCH_STATUS_OUT_OF_MEMORY;
	status = notmuch_indexopts_set_decrypt_policy (indexing_cli_choices.opts,
						       indexing_cli_choices.decrypt_policy);
	if (status != NOTMUCH_STATUS_SUCCESS) {
	    fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
		     indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
	    notmuch_indexopts_destroy (indexing_cli_choices.opts);
	    indexing_cli_choices.opts = NULL;
	    return status;
	}
    }
    return NOTMUCH_STATUS_SUCCESS;
}


static const command_t commands[] = {
    { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
      "Notmuch main command." },
    { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
      "Interactively set up notmuch for first use." },
    { "new", notmuch_new_command,
      NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
      NOTMUCH_COMMAND_DATABASE_CREATE,
      "Find and import new messages to the notmuch database." },
    { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
      NOTMUCH_COMMAND_DATABASE_WRITE,
      "Add a new message into the maildir and notmuch database." },
    { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
      "Search for messages matching the given search terms." },
    { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
      "Get addresses from messages matching the given search terms." },
    { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
      "Show all messages matching the search terms." },
    { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
      "Count messages matching the search terms." },
    { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
      "Construct a reply template for a set of messages." },
    { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
      "Add/remove tags for all messages matching the search terms." },
    { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
      "Create a plain-text dump of the tags for each message." },
    { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
      NOTMUCH_COMMAND_DATABASE_WRITE,
      "Restore the tags from the given dump file (see 'dump')." },
    { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
      NOTMUCH_COMMAND_DATABASE_WRITE,
      "Compact the notmuch database." },
    { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
      NOTMUCH_COMMAND_DATABASE_WRITE,
      "Re-index all messages matching the search terms." },
    { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_LOAD,
      "Get or set settings in the notmuch configuration file." },
#if WITH_EMACS
    { "emacs-mua", NULL, 0,
      "send mail with notmuch and emacs." },
#endif
    { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
      "This message, or more detailed help for the named command." }
};

typedef struct help_topic {
    const char *name;
    const char *summary;
} help_topic_t;

static const help_topic_t help_topics[] = {
    { "search-terms",
      "Common search term syntax." },
    { "hooks",
      "Hooks that will be run before or after certain commands." },
    { "properties",
      "Message property conventions and documentation." },
};

static const command_t *
find_command (const char *name)
{
    size_t i;

    for (i = 0; i < ARRAY_SIZE (commands); i++)
	if ((! name && ! commands[i].name) ||
	    (name && commands[i].name && strcmp (name, commands[i].name) == 0))
	    return &commands[i];

    return NULL;
}

int notmuch_format_version;

static void
usage (FILE *out)
{
    const command_t *command;
    const help_topic_t *topic;
    unsigned int i;

    fprintf (out,
	     "Usage: notmuch --help\n"
	     "       notmuch --version\n"
	     "       notmuch <command> [args...]\n");
    fprintf (out, "\n");
    fprintf (out, "The available commands are as follows:\n");
    fprintf (out, "\n");

    for (i = 0; i < ARRAY_SIZE (commands); i++) {
	command = &commands[i];

	if (command->name)
	    fprintf (out, "  %-12s  %s\n", command->name, command->summary);
    }

    fprintf (out, "\n");
    fprintf (out, "Additional help topics are as follows:\n");
    fprintf (out, "\n");

    for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
	topic = &help_topics[i];
	fprintf (out, "  %-12s  %s\n", topic->name, topic->summary);
    }

    fprintf (out, "\n");
    fprintf (out,
	     "Use \"notmuch help <command or topic>\" for more details "
	     "on each command or topic.\n\n");
}

void
notmuch_exit_if_unsupported_format (void)
{
    if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
	fprintf (stderr,
		 "\
A caller requested output format version %d, but the installed notmuch\n\
CLI only supports up to format version %d.  You may need to upgrade your\n\
notmuch CLI.\n",
		 notmuch_format_version, NOTMUCH_FORMAT_CUR);
	exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
    } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
	fprintf (stderr,
		 "\
A caller requested output format version %d, which is no longer supported\n\
by the notmuch CLI (it requires at least version %d).  You may need to\n\
upgrade your notmuch front-end.\n",
		 notmuch_format_version, NOTMUCH_FORMAT_MIN);
	exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
    } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
	/* Warn about old version requests so compatibility issues are
	 * less likely when we drop support for a deprecated format
	 * versions. */
	fprintf (stderr,
		 "\
A caller requested deprecated output format version %d, which may not\n\
be supported in the future.\n", notmuch_format_version);
    }
}

static void
notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
{
    const char *uuid = NULL;

    if (! notmuch_requested_db_uuid)
	return;
    IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));

    if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
	fprintf (stderr, "Error: requested database revision %s does not match %s\n",
		 notmuch_requested_db_uuid, uuid);
	exit (1);
    }
}

static void
exec_man (const char *page)
{
    if (execlp ("man", "man", page, (char *) NULL)) {
	perror ("exec man");
	exit (1);
    }
}

static int
_help_for (const char *topic_name)
{
    const command_t *command;
    const help_topic_t *topic;
    unsigned int i;

    if (! topic_name) {
	printf ("The notmuch mail system.\n\n");
	usage (stdout);
	return EXIT_SUCCESS;
    }

    if (strcmp (topic_name, "help") == 0) {
	printf ("The notmuch help system.\n\n"
		"\tNotmuch uses the man command to display help. In case\n"
		"\tof difficulties check that MANPATH includes the pages\n"
		"\tinstalled by notmuch.\n\n"
		"\tTry \"notmuch help\" for a list of topics.\n");
	return EXIT_SUCCESS;
    }

    command = find_command (topic_name);
    if (command) {
	char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
	exec_man (page);
    }

    for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
	topic = &help_topics[i];
	if (strcmp (topic_name, topic->name) == 0) {
	    char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
	    exec_man (page);
	}
    }

    fprintf (stderr,
	     "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
	     topic_name);
    return EXIT_FAILURE;
}

static int
notmuch_help_command (unused(notmuch_database_t *notmuch), int argc, char *argv[])
{
    int opt_index;

    opt_index = notmuch_minimal_options ("help", argc, argv);
    if (opt_index < 0)
	return EXIT_FAILURE;

    /* skip at least subcommand argument */
    argc -= opt_index;
    argv += opt_index;

    if (argc == 0) {
	return _help_for (NULL);
    }

    return _help_for (argv[0]);
}

/* Handle the case of "notmuch" being invoked with no command
 * argument. For now we just call notmuch_setup_command, but we plan
 * to be more clever about this in the future.
 */
static int
notmuch_command (notmuch_database_t *notmuch,
		 unused(int argc), unused(char **argv))
{

    const char *config_path;

    /* If the user has not created a configuration file, then run
     * notmuch_setup_command which will give a nice welcome message,
     * and interactively guide the user through the configuration. */
    config_path = notmuch_config_path (notmuch);
    if (access (config_path, R_OK | F_OK) == -1) {
	if (errno != ENOENT) {
	    fprintf (stderr, "Error: %s config file access failed: %s\n", config_path,
		     strerror (errno));
	    return EXIT_FAILURE;
	} else {
	    return notmuch_setup_command (notmuch, 0, NULL);
	}
    }

    printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
	    "At this point you can start exploring the functionality of notmuch by\n"
	    "using commands such as:\n\n"
	    "\tnotmuch search tag:inbox\n\n"
	    "\tnotmuch search to:\"%s\"\n\n"
	    "\tnotmuch search from:\"%s\"\n\n"
	    "\tnotmuch search subject:\"my favorite things\"\n\n"
	    "See \"notmuch help search\" for more details.\n\n"
	    "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
	    "from a search. Finally, you may want to explore using a more sophisticated\n"
	    "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
	    "or any other interface described at https://notmuchmail.org\n\n"
	    "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
	    "Have fun, and may your inbox never have much mail.\n\n",
	    notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME),
	    notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));

    return EXIT_SUCCESS;
}

/*
 * Try to run subcommand in argv[0] as notmuch- prefixed external
 * command. argv must be NULL terminated (argv passed to main always
 * is).
 *
 * Does not return if the external command is found and
 * executed. Return true if external command is not found. Return
 * false on errors.
 */
static bool
try_external_command (char *argv[])
{
    char *old_argv0 = argv[0];
    bool ret = true;

    argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);

    /*
     * This will only return on errors. Not finding an external
     * command (ENOENT) is not an error from our perspective.
     */
    execvp (argv[0], argv);
    if (errno != ENOENT) {
	fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
		 argv[0], strerror (errno));
	ret = false;
    }

    talloc_free (argv[0]);
    argv[0] = old_argv0;

    return ret;
}

int
main (int argc, char *argv[])
{
    void *local;
    char *talloc_report;
    const char *command_name = NULL;
    const command_t *command;
    const char *config_file_name = NULL;
    notmuch_database_t *notmuch = NULL;
    int opt_index;
    int ret = EXIT_SUCCESS;

    notmuch_opt_desc_t options[] = {
	{ .opt_string = &config_file_name, .name = "config", .allow_empty = TRUE },
	{ .opt_inherit = notmuch_shared_options },
	{ }
    };

    notmuch_client_init ();

    local = talloc_new (NULL);

    /* Globally default to the current output format version. */
    notmuch_format_version = NOTMUCH_FORMAT_CUR;

    opt_index = parse_arguments (argc, argv, options, 1);
    if (opt_index < 0) {
	ret = EXIT_FAILURE;
	goto DONE;
    }

    if (opt_index < argc)
	command_name = argv[opt_index];

    notmuch_process_shared_options (NULL, command_name);

    command = find_command (command_name);
    /* if command->function is NULL, try external command */
    if (! command || ! command->function) {
	/* This won't return if the external command is found. */
	if (try_external_command (argv + opt_index))
	    fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
		     command_name);
	ret = EXIT_FAILURE;
	goto DONE;
    }

    if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
	char *status_string = NULL;
	notmuch_database_mode_t mode;
	notmuch_status_t status;

	if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
	    command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
	    mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
	else
	    mode = NOTMUCH_DATABASE_MODE_READ_ONLY;

	if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
	    status = notmuch_database_create_with_config (NULL,
							  config_file_name,
							  NULL,
							  &notmuch,
							  &status_string);
	    if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
		if (status_string) {
		    fputs (status_string, stderr);
		    free (status_string);
		}

		if (status == NOTMUCH_STATUS_NO_CONFIG)
		    fputs ("Try running 'notmuch setup' to create a configuration.", stderr);

		return EXIT_FAILURE;
	    }
	}

	if (notmuch == NULL) {
	    status = notmuch_database_open_with_config (NULL,
							mode,
							config_file_name,
							NULL,
							&notmuch,
							&status_string);
	    if (status) {
		if (status_string) {
		    fputs (status_string, stderr);
		    free (status_string);
		}

		return EXIT_FAILURE;
	    }
	}
    }

    if (command->mode & NOTMUCH_COMMAND_CONFIG_LOAD) {
	char *status_string = NULL;
	notmuch_status_t status;
	status = notmuch_database_load_config (NULL,
					       config_file_name,
					       NULL,
					       &notmuch,
					       &status_string);

	if (status == NOTMUCH_STATUS_NO_CONFIG && ! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
	    fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
	    goto DONE;
	}
	switch (status) {
	case NOTMUCH_STATUS_NO_CONFIG:
	    if (! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
		fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
		goto DONE;
	    }
	    break;
	case NOTMUCH_STATUS_NO_DATABASE:
	    if (! command_name) {
		printf ("Notmuch is configured, but no database was found.\n");
		printf ("You probably want to run \"notmuch new\" now to create a database.\n\n"
			"Note that the first run of \"notmuch new\" can take a very long time\n"
			"and that the resulting database will use roughly the same amount of\n"
			"storage space as the email being indexed.\n\n");
		status = NOTMUCH_STATUS_SUCCESS;
		goto DONE;
	    }
	    break;
	case NOTMUCH_STATUS_SUCCESS:
	    break;
	default:
	    goto DONE;
	}

    }

    ret = (command->function)(notmuch, argc - opt_index, argv + opt_index);

  DONE:
    talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
    if (talloc_report && strcmp (talloc_report, "") != 0) {
	/* this relies on the previous call to
	 * talloc_enable_null_tracking
	 */

	FILE *report = fopen (talloc_report, "a");
	if (report) {
	    talloc_report_full (NULL, report);
	} else {
	    ret = 1;
	    fprintf (stderr, "ERROR: unable to write talloc log. ");
	    perror (talloc_report);
	}
    }

    talloc_free (local);

    return ret;
}