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 *
make_path_absolute(void * ctx,const char * path)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
welcome_message_pre_setup(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
welcome_message_post_setup(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
print_tag_list(notmuch_config_values_t * tags)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 *
parse_tag_list(void * ctx,char * response)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
notmuch_setup_command(notmuch_database_t * notmuch,int argc,char * argv[])127 notmuch_setup_command (notmuch_database_t *notmuch,
128 int argc, char *argv[])
129 {
130 char *response = NULL;
131 size_t response_size = 0;
132 GPtrArray *other_emails;
133 notmuch_config_values_t *new_tags, *search_exclude_tags, *emails;
134 notmuch_conffile_t *config;
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 config = notmuch_conffile_open (notmuch,
151 notmuch_config_path (notmuch), true);
152 if (! config)
153 return EXIT_FAILURE;
154
155 if (notmuch_conffile_is_new (config))
156 welcome_message_pre_setup ();
157
158 prompt ("Your full name [%s]: ", notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME));
159 if (strlen (response))
160 notmuch_conffile_set_user_name (config, response);
161
162 prompt ("Your primary email address [%s]: ",
163 notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
164 if (strlen (response))
165 notmuch_conffile_set_user_primary_email (config, response);
166
167 other_emails = g_ptr_array_new ();
168
169 for (emails = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_OTHER_EMAIL);
170 notmuch_config_values_valid (emails);
171 notmuch_config_values_move_to_next (emails)) {
172 const char *email = notmuch_config_values_get (emails);
173
174 prompt ("Additional email address [%s]: ", email);
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, email));
179 }
180
181 do {
182 prompt ("Additional email address [Press 'Enter' if none]: ");
183 if (strlen (response))
184 g_ptr_array_add (other_emails, talloc_strdup (config, response));
185 } while (strlen (response));
186 if (other_emails->len)
187 notmuch_conffile_set_user_other_email (config,
188 (const char **)
189 other_emails->pdata,
190 other_emails->len);
191 g_ptr_array_free (other_emails, true);
192
193 prompt ("Top-level directory of your email archive [%s]: ",
194 notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH));
195 if (strlen (response)) {
196 const char *absolute_path;
197
198 absolute_path = make_path_absolute (config, response);
199 notmuch_conffile_set_database_path (config, absolute_path);
200 }
201
202 new_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_NEW_TAGS);
203
204 printf ("Tags to apply to all new messages (separated by spaces) [");
205 print_tag_list (new_tags);
206 prompt ("]: ");
207
208 if (strlen (response)) {
209 GPtrArray *tags = parse_tag_list (config, response);
210
211 notmuch_conffile_set_new_tags (config, (const char **) tags->pdata,
212 tags->len);
213
214 g_ptr_array_free (tags, true);
215 }
216
217 search_exclude_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_EXCLUDE_TAGS);
218
219 printf ("Tags to exclude when searching messages (separated by spaces) [");
220 print_tag_list (search_exclude_tags);
221 prompt ("]: ");
222
223 if (strlen (response)) {
224 GPtrArray *tags = parse_tag_list (config, response);
225
226 notmuch_conffile_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_conffile_save (config))
234 return EXIT_FAILURE;
235
236 if (config)
237 notmuch_conffile_close (config);
238
239 if (notmuch_conffile_is_new (config))
240 welcome_message_post_setup ();
241
242 return EXIT_SUCCESS;
243 }
244