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     for (i = 0; i < tags_len; i++) {
  95         if (i != 0)
  96             printf (" ");
  97         printf ("%s", tags[i]);
  98     }
  99 }
 100
 101 static GPtrArray *
 102 parse_tag_list (void *ctx, char *response)
 103 {
 104     GPtrArray *tags = g_ptr_array_new ();
 105     char *tag = response;
 106     char *space;
 107
 108     while (tag && *tag) {
 109         space = strchr (tag, ' ');
 110         if (space)
 111             g_ptr_array_add (tags, talloc_strndup (ctx, tag, space - tag));
 112         else
 113             g_ptr_array_add (tags, talloc_strdup (ctx, tag));
 114         tag = space;
 115         while (tag && *tag == ' ')
 116             tag++;
 117     }
 118
 119     return tags;
 120 }
 121
 122 int
 123 notmuch_setup_command (notmuch_config_t *config,
 124                        unused (int argc), unused (char *argv[]))
 125 {
 126     char *response = NULL;
 127     size_t response_size = 0;
 128     const char **old_other_emails;
 129     size_t old_other_emails_len;
 130     GPtrArray *other_emails;
 131     unsigned int i;
 132     const char **new_tags;
 133     size_t new_tags_len;
 134     const char **search_exclude_tags;
 135     size_t search_exclude_tags_len;
 136
 137 #define prompt(format, ...)                                     \
 138     do {                                                        \
 139         printf (format, ##__VA_ARGS__);                         \
 140         fflush (stdout);                                        \
 141         if (getline (&response, &response_size, stdin) < 0) {   \
 142             printf ("Exiting.\n");                              \
 143             exit (EXIT_FAILURE);                                \
 144         }                                                       \
 145         chomp_newline (response);                               \
 146     } while (0)
 147
 148     if (notmuch_minimal_options ("setup", argc, argv) < 0)
 149         return EXIT_FAILURE;
 150
 151     if (notmuch_requested_db_uuid)
 152         fprintf (stderr, "Warning: ignoring --uuid=%s\n",
 153                  notmuch_requested_db_uuid);
 154
 155     if (notmuch_config_is_new (config))
 156         welcome_message_pre_setup ();
 157
 158     prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));
 159     if (strlen (response))
 160         notmuch_config_set_user_name (config, response);
 161
 162     prompt ("Your primary email address [%s]: ",
 163             notmuch_config_get_user_primary_email (config));
 164     if (strlen (response))
 165         notmuch_config_set_user_primary_email (config, response);
 166
 167     other_emails = g_ptr_array_new ();
 168
 169     old_other_emails = notmuch_config_get_user_other_email (config,
 170                                              &old_other_emails_len);
 171     for (i = 0; i < old_other_emails_len; i++) {
 172         prompt ("Additional email address [%s]: ", old_other_emails[i]);
 173         if (strlen (response))
 174             g_ptr_array_add (other_emails, talloc_strdup (config, response));
 175         else
 176             g_ptr_array_add (other_emails, talloc_strdup (config,
 177                                                          old_other_emails[i]));
 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_database_path (config));
 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_new_tags (config, &new_tags_len);
 202
 203     printf ("Tags to apply to all new messages (separated by spaces) [");
 204     print_tag_list (new_tags, new_tags_len);
 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
 217     search_exclude_tags = notmuch_config_get_search_exclude_tags (config, &search_exclude_tags_len);
 218
 219     printf ("Tags to exclude when searching messages (separated by spaces) [");
 220     print_tag_list (search_exclude_tags, search_exclude_tags_len);
 221     prompt ("]: ");
 222
 223     if (strlen (response)) {
 224         GPtrArray *tags = parse_tag_list (config, response);
 225
 226         notmuch_config_set_search_exclude_tags (config,
 227                                                 (const char **) tags->pdata,
 228                                                 tags->len);
 229
 230         g_ptr_array_free (tags, TRUE);
 231     }
 232
 233     if (notmuch_config_save (config))
 234         return EXIT_FAILURE;
 235
 236     if (notmuch_config_is_new (config))
 237         welcome_message_post_setup ();
 238
 239     return EXIT_SUCCESS;
 240 }