git.cworth.org Git - notmuch/blob - notmuch-setup.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-client.h"
  22
  23 static const char *
  24 make_path_absolute (void *ctx, const char *path)
  25 {
  26     char *cwd;
  27
  28     if (*path == '/')
  29         return path;
  30
  31     cwd = getcwd (NULL, 0);
  32     if (cwd == NULL) {
  33         fprintf (stderr, "Out of memory.\n");
  34         return NULL;
  35     }
  36
  37     path = talloc_asprintf (ctx, "%s/%s", cwd, path);
  38     if (path == NULL)
  39         fprintf (stderr, "Out of memory.\n");
  40
  41     free (cwd);
  42
  43     return path;
  44 }
  45
  46 static void
  47 welcome_message_pre_setup (void)
  48 {
  49     printf (
  50         "Welcome to notmuch!\n\n"
  51
  52         "The goal of notmuch is to help you manage and search your collection of\n"
  53         "email, and to efficiently keep up with the flow of email as it comes in.\n\n"
  54
  55         "Notmuch needs to know a few things about you such as your name and email\n"
  56         "address, as well as the directory that contains your email. This is where\n"
  57         "you already have mail stored and where messages will be delivered in the\n"
  58         "future. This directory can contain any number of sub-directories. Regular\n"
  59         "files in these directories should be individual email messages. If there\n"
  60         "are other, non-email files (such as indexes maintained by other email\n"
  61         "programs) then notmuch will do its best to detect those and ignore them.\n\n"
  62
  63         "If you already have your email being delivered to directories in either\n"
  64         "maildir or mh format, then that's perfect. Mail storage that uses mbox\n"
  65         "format, (where one mbox file contains many messages), will not work with\n"
  66         "notmuch. If that's how your mail is currently stored, we recommend you\n"
  67         "first convert it to maildir format with a utility such as mb2md. You can\n"
  68         "continue configuring notmuch now, but be sure to complete the conversion\n"
  69         "before you run \"notmuch new\" for the first time.\n\n");
  70 }
  71
  72 static void
  73 welcome_message_post_setup (void)
  74 {
  75     printf ("\n"
  76             "Notmuch is now configured, and the configuration settings are saved in\n"
  77             "a file in your home directory named .notmuch-config . If you'd like to\n"
  78             "change the configuration in the future, you can either edit that file\n"
  79             "directly or run \"notmuch setup\".  To choose an alternate configuration\n"
  80             "location, set ${NOTMUCH_CONFIG}.\n\n"
  81
  82             "The next step is to run \"notmuch new\" which will create a database\n"
  83             "that indexes all of your mail. Depending on the amount of mail you have\n"
  84             "the initial indexing process can take a long time, so expect that.\n"
  85             "Also, the resulting database will require roughly the same amount of\n"
  86             "storage space as your current collection of email. So please ensure you\n"
  87             "have sufficient storage space available now.\n\n");
  88 }
  89
  90 static void
  91 print_tag_list (notmuch_config_values_t *tags)
  92 {
  93     bool first = false;
  94
  95     for (;
  96          notmuch_config_values_valid (tags);
  97          notmuch_config_values_move_to_next (tags)) {
  98         if (! first)
  99             printf (" ");
 100         first = false;
 101         printf ("%s", notmuch_config_values_get (tags));
 102     }
 103 }
 104
 105 static GPtrArray *
 106 parse_tag_list (void *ctx, char *response)
 107 {
 108     GPtrArray *tags = g_ptr_array_new ();
 109     char *tag = response;
 110     char *space;
 111
 112     while (tag && *tag) {
 113         space = strchr (tag, ' ');
 114         if (space)
 115             g_ptr_array_add (tags, talloc_strndup (ctx, tag, space - tag));
 116         else
 117             g_ptr_array_add (tags, talloc_strdup (ctx, tag));
 118         tag = space;
 119         while (tag && *tag == ' ')
 120             tag++;
 121     }
 122
 123     return tags;
 124 }
 125
 126 int
 127 notmuch_setup_command (notmuch_config_t *config,
 128                        notmuch_database_t *notmuch,
 129                        int argc, char *argv[])
 130 {
 131     char *response = NULL;
 132     size_t response_size = 0;
 133     GPtrArray *other_emails;
 134     notmuch_config_values_t *new_tags, *search_exclude_tags, *emails;
 135
 136 #define prompt(format, ...)                                     \
 137     do {                                                        \
 138         printf (format, ##__VA_ARGS__);                         \
 139         fflush (stdout);                                        \
 140         if (getline (&response, &response_size, stdin) < 0) {   \
 141             printf ("Exiting.\n");                              \
 142             exit (EXIT_FAILURE);                                \
 143         }                                                       \
 144         chomp_newline (response);                               \
 145     } while (0)
 146
 147     if (notmuch_minimal_options ("setup", argc, argv) < 0)
 148         return EXIT_FAILURE;
 149
 150     if (notmuch_requested_db_uuid)
 151         fprintf (stderr, "Warning: ignoring --uuid=%s\n",
 152                  notmuch_requested_db_uuid);
 153
 154     if (notmuch_config_is_new (config))
 155         welcome_message_pre_setup ();
 156
 157     prompt ("Your full name [%s]: ", notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME));
 158     if (strlen (response))
 159         notmuch_config_set_user_name (config, response);
 160
 161     prompt ("Your primary email address [%s]: ",
 162             notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
 163     if (strlen (response))
 164         notmuch_config_set_user_primary_email (config, response);
 165
 166     other_emails = g_ptr_array_new ();
 167
 168     for (emails = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_OTHER_EMAIL);
 169          notmuch_config_values_valid (emails);
 170          notmuch_config_values_move_to_next (emails)) {
 171         const char *email = notmuch_config_values_get (emails);
 172
 173         prompt ("Additional email address [%s]: ", email);
 174         if (strlen (response))
 175             g_ptr_array_add (other_emails, talloc_strdup (config, response));
 176         else
 177             g_ptr_array_add (other_emails, talloc_strdup (config, email));
 178     }
 179
 180     do {
 181         prompt ("Additional email address [Press 'Enter' if none]: ");
 182         if (strlen (response))
 183             g_ptr_array_add (other_emails, talloc_strdup (config, response));
 184     } while (strlen (response));
 185     if (other_emails->len)
 186         notmuch_config_set_user_other_email (config,
 187                                              (const char **)
 188                                              other_emails->pdata,
 189                                              other_emails->len);
 190     g_ptr_array_free (other_emails, true);
 191
 192     prompt ("Top-level directory of your email archive [%s]: ",
 193             notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH));
 194     if (strlen (response)) {
 195         const char *absolute_path;
 196
 197         absolute_path = make_path_absolute (config, response);
 198         notmuch_config_set_database_path (config, absolute_path);
 199     }
 200
 201     new_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_NEW_TAGS);
 202
 203     printf ("Tags to apply to all new messages (separated by spaces) [");
 204     print_tag_list (new_tags);
 205     prompt ("]: ");
 206
 207     if (strlen (response)) {
 208         GPtrArray *tags = parse_tag_list (config, response);
 209
 210         notmuch_config_set_new_tags (config, (const char **) tags->pdata,
 211                                      tags->len);
 212
 213         g_ptr_array_free (tags, true);
 214     }
 215
 216     search_exclude_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_EXCLUDE_TAGS);
 217
 218     printf ("Tags to exclude when searching messages (separated by spaces) [");
 219     print_tag_list (search_exclude_tags);
 220     prompt ("]: ");
 221
 222     if (strlen (response)) {
 223         GPtrArray *tags = parse_tag_list (config, response);
 224
 225         notmuch_config_set_search_exclude_tags (config,
 226                                                 (const char **) tags->pdata,
 227                                                 tags->len);
 228
 229         g_ptr_array_free (tags, true);
 230     }
 231
 232     if (notmuch_config_save (config))
 233         return EXIT_FAILURE;
 234
 235     if (notmuch_config_is_new (config))
 236         welcome_message_post_setup ();
 237
 238     return EXIT_SUCCESS;
 239 }