git.notmuchmail.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 (const char **tags, size_t tags_len)
  92 {
  93     unsigned int i;
  94
  95     for (i = 0; i < tags_len; i++) {
  96         if (i != 0)
  97             printf (" ");
  98         printf ("%s", tags[i]);
  99     }
 100 }
 101
 102 static GPtrArray *
 103 parse_tag_list (void *ctx, char *response)
 104 {
 105     GPtrArray *tags = g_ptr_array_new ();
 106     char *tag = response;
 107     char *space;
 108
 109     while (tag && *tag) {
 110         space = strchr (tag, ' ');
 111         if (space)
 112             g_ptr_array_add (tags, talloc_strndup (ctx, tag, space - tag));
 113         else
 114             g_ptr_array_add (tags, talloc_strdup (ctx, tag));
 115         tag = space;
 116         while (tag && *tag == ' ')
 117             tag++;
 118     }
 119
 120     return tags;
 121 }
 122
 123 int
 124 notmuch_setup_command (notmuch_config_t *config,
 125                        unused(notmuch_database_t *notmuch),
 126                        int argc, char *argv[])
 127 {
 128     char *response = NULL;
 129     size_t response_size = 0;
 130     const char **old_other_emails;
 131     size_t old_other_emails_len;
 132     GPtrArray *other_emails;
 133     unsigned int i;
 134     const char **new_tags;
 135     size_t new_tags_len;
 136     const char **search_exclude_tags;
 137     size_t search_exclude_tags_len;
 138
 139 #define prompt(format, ...)                                     \
 140     do {                                                        \
 141         printf (format, ##__VA_ARGS__);                         \
 142         fflush (stdout);                                        \
 143         if (getline (&response, &response_size, stdin) < 0) {   \
 144             printf ("Exiting.\n");                              \
 145             exit (EXIT_FAILURE);                                \
 146         }                                                       \
 147         chomp_newline (response);                               \
 148     } while (0)
 149
 150     if (notmuch_minimal_options ("setup", argc, argv) < 0)
 151         return EXIT_FAILURE;
 152
 153     if (notmuch_requested_db_uuid)
 154         fprintf (stderr, "Warning: ignoring --uuid=%s\n",
 155                  notmuch_requested_db_uuid);
 156
 157     if (notmuch_config_is_new (config))
 158         welcome_message_pre_setup ();
 159
 160     prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));
 161     if (strlen (response))
 162         notmuch_config_set_user_name (config, response);
 163
 164     prompt ("Your primary email address [%s]: ",
 165             notmuch_config_get_user_primary_email (config));
 166     if (strlen (response))
 167         notmuch_config_set_user_primary_email (config, response);
 168
 169     other_emails = g_ptr_array_new ();
 170
 171     old_other_emails = notmuch_config_get_user_other_email (config,
 172                                                             &old_other_emails_len);
 173     for (i = 0; i < old_other_emails_len; i++) {
 174         prompt ("Additional email address [%s]: ", old_other_emails[i]);
 175         if (strlen (response))
 176             g_ptr_array_add (other_emails, talloc_strdup (config, response));
 177         else
 178             g_ptr_array_add (other_emails, talloc_strdup (config,
 179                                                           old_other_emails[i]));
 180     }
 181
 182     do {
 183         prompt ("Additional email address [Press 'Enter' if none]: ");
 184         if (strlen (response))
 185             g_ptr_array_add (other_emails, talloc_strdup (config, response));
 186     } while (strlen (response));
 187     if (other_emails->len)
 188         notmuch_config_set_user_other_email (config,
 189                                              (const char **)
 190                                              other_emails->pdata,
 191                                              other_emails->len);
 192     g_ptr_array_free (other_emails, true);
 193
 194     prompt ("Top-level directory of your email archive [%s]: ",
 195             notmuch_config_get_database_path (config));
 196     if (strlen (response)) {
 197         const char *absolute_path;
 198
 199         absolute_path = make_path_absolute (config, response);
 200         notmuch_config_set_database_path (config, absolute_path);
 201     }
 202
 203     new_tags = notmuch_config_get_new_tags (config, &new_tags_len);
 204
 205     printf ("Tags to apply to all new messages (separated by spaces) [");
 206     print_tag_list (new_tags, new_tags_len);
 207     prompt ("]: ");
 208
 209     if (strlen (response)) {
 210         GPtrArray *tags = parse_tag_list (config, response);
 211
 212         notmuch_config_set_new_tags (config, (const char **) tags->pdata,
 213                                      tags->len);
 214
 215         g_ptr_array_free (tags, true);
 216     }
 217
 218
 219     search_exclude_tags = notmuch_config_get_search_exclude_tags (config, &search_exclude_tags_len);
 220
 221     printf ("Tags to exclude when searching messages (separated by spaces) [");
 222     print_tag_list (search_exclude_tags, search_exclude_tags_len);
 223     prompt ("]: ");
 224
 225     if (strlen (response)) {
 226         GPtrArray *tags = parse_tag_list (config, response);
 227
 228         notmuch_config_set_search_exclude_tags (config,
 229                                                 (const char **) tags->pdata,
 230                                                 tags->len);
 231
 232         g_ptr_array_free (tags, true);
 233     }
 234
 235     if (notmuch_config_save (config))
 236         return EXIT_FAILURE;
 237
 238     if (notmuch_config_is_new (config))
 239         welcome_message_post_setup ();
 240
 241     return EXIT_SUCCESS;
 242 }