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 http://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 (unused (void *ctx),
 124                        unused (int argc), unused (char *argv[]))
 125 {
 126     char *response = NULL;
 127     size_t response_size = 0;
 128     notmuch_config_t *config;
 129     const char **old_other_emails;
 130     size_t old_other_emails_len;
 131     GPtrArray *other_emails;
 132     unsigned int i;
 133     int is_new;
 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 (1);                                           \
 146         }                                                       \
 147         chomp_newline (response);                               \
 148     } while (0)
 149
 150     config = notmuch_config_open (ctx, NULL, &is_new);
 151
 152     if (is_new)
 153         welcome_message_pre_setup ();
 154
 155     prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));
 156     if (strlen (response))
 157         notmuch_config_set_user_name (config, response);
 158
 159     prompt ("Your primary email address [%s]: ",
 160             notmuch_config_get_user_primary_email (config));
 161     if (strlen (response))
 162         notmuch_config_set_user_primary_email (config, response);
 163
 164     other_emails = g_ptr_array_new ();
 165
 166     old_other_emails = notmuch_config_get_user_other_email (config,
 167                                              &old_other_emails_len);
 168     for (i = 0; i < old_other_emails_len; i++) {
 169         prompt ("Additional email address [%s]: ", old_other_emails[i]);
 170         if (strlen (response))
 171             g_ptr_array_add (other_emails, talloc_strdup (ctx, response));
 172         else
 173             g_ptr_array_add (other_emails, talloc_strdup (ctx,
 174                                                          old_other_emails[i]));
 175     }
 176
 177     do {
 178         prompt ("Additional email address [Press 'Enter' if none]: ");
 179         if (strlen (response))
 180             g_ptr_array_add (other_emails, talloc_strdup (ctx, response));
 181     } while (strlen (response));
 182     if (other_emails->len)
 183         notmuch_config_set_user_other_email (config,
 184                                              (const char **)
 185                                              other_emails->pdata,
 186                                              other_emails->len);
 187     g_ptr_array_free (other_emails, TRUE);
 188
 189     prompt ("Top-level directory of your email archive [%s]: ",
 190             notmuch_config_get_database_path (config));
 191     if (strlen (response)) {
 192         const char *absolute_path;
 193
 194         absolute_path = make_path_absolute (ctx, response);
 195         notmuch_config_set_database_path (config, absolute_path);
 196     }
 197
 198     new_tags = notmuch_config_get_new_tags (config, &new_tags_len);
 199
 200     printf ("Tags to apply to all new messages (separated by spaces) [");
 201     print_tag_list (new_tags, new_tags_len);
 202     prompt ("]: ");
 203
 204     if (strlen (response)) {
 205         GPtrArray *tags = parse_tag_list (ctx, response);
 206
 207         notmuch_config_set_new_tags (config, (const char **) tags->pdata,
 208                                      tags->len);
 209
 210         g_ptr_array_free (tags, TRUE);
 211     }
 212
 213
 214     search_exclude_tags = notmuch_config_get_search_exclude_tags (config, &search_exclude_tags_len);
 215
 216     printf ("Tags to exclude when searching messages (separated by spaces) [");
 217     print_tag_list (search_exclude_tags, search_exclude_tags_len);
 218     prompt ("]: ");
 219
 220     if (strlen (response)) {
 221         GPtrArray *tags = parse_tag_list (ctx, response);
 222
 223         notmuch_config_set_search_exclude_tags (config,
 224                                                 (const char **) tags->pdata,
 225                                                 tags->len);
 226
 227         g_ptr_array_free (tags, TRUE);
 228     }
 229
 230
 231     if (! notmuch_config_save (config)) {
 232         if (is_new)
 233           welcome_message_post_setup ();
 234         return 0;
 235     } else {
 236         return 1;
 237     }
 238 }