1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
26 static const char toplevel_config_comment[] =
27 " .notmuch-config - Configuration file for the notmuch mail system\n"
29 " For more information about notmuch, see http://notmuchmail.org";
31 static const char database_config_comment[] =
32 " Database configuration\n"
34 " The only value supported here is 'path' which should be the top-level\n"
35 " directory where your mail currently exists and to where mail will be\n"
36 " delivered in the future. Files should be individual email messages.\n"
37 " Notmuch will store its database within a sub-directory of the path\n"
38 " configured here named \".notmuch\".\n";
40 static const char user_config_comment[] =
41 " User configuration\n"
43 " Here is where you can let notmuch know how you would like to be\n"
44 " addressed. Valid settings are\n"
46 "\tname Your full name.\n"
47 "\tprimary_email Your primary email address.\n"
48 "\tother_email A list (separated by ';') of other email addresses\n"
49 "\t at which you receive email.\n"
51 " Notmuch will use the various email addresses configured here when\n"
52 " formatting replies. It will avoid including your own addresses in the\n"
53 " recipient list of replies, and will set the From address based on the\n"
54 " address to which the original email was addressed.\n";
56 struct _notmuch_config {
62 char *user_primary_email;
63 char **user_other_email;
64 size_t user_other_email_length;
68 notmuch_config_destructor (notmuch_config_t *config)
71 g_key_file_free (config->key_file);
77 get_name_from_passwd_file (void *ctx)
79 long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
80 char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
81 struct passwd passwd, *ignored;
85 if (pw_buf_size == -1) pw_buf_size = 64;
87 while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
88 pw_buf_size, &ignored)) == ERANGE) {
89 pw_buf_size = pw_buf_size * 2;
90 pw_buf = talloc_zero_size(ctx, pw_buf_size);
94 char *comma = strchr (passwd.pw_gecos, ',');
96 name = talloc_strndup (ctx, passwd.pw_gecos,
97 comma - passwd.pw_gecos);
99 name = talloc_strdup (ctx, passwd.pw_gecos);
101 name = talloc_strdup (ctx, "");
104 talloc_free (pw_buf);
110 get_username_from_passwd_file (void *ctx)
112 long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
113 char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
114 struct passwd passwd, *ignored;
118 if (pw_buf_size == -1) pw_buf_size = 64;
119 while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
120 pw_buf_size, &ignored)) == ERANGE) {
121 pw_buf_size = pw_buf_size * 2;
122 pw_buf = talloc_zero_size(ctx, pw_buf_size);
126 name = talloc_strdup (ctx, passwd.pw_name);
128 name = talloc_strdup (ctx, "");
130 talloc_free (pw_buf);
135 /* Open the named notmuch configuration file. A filename of NULL will
136 * be interpreted as the default configuration file
137 * ($HOME/.notmuch-config).
139 * If any error occurs, (out of memory, or a permission-denied error,
140 * etc.), this function will print a message to stderr and return
143 * Note: It is *not* an error if the specified configuration file does
144 * not exist. In this case, a default configuration will be created
145 * and returned. Subsequently calling notmuch_config_save will cause
146 * the configuration to be written to the filename specified at the
147 * time of notmuch_config_open.
149 * The default configuration settings are determined as follows:
151 * database_path: $HOME/mail
153 * user_name: From /etc/passwd
155 * user_primary_mail: $EMAIL variable if set, otherwise
156 * constructed from the username and
157 * hostname of the current machine.
159 * user_other_email: Not set.
161 * The default configuration also contains comments to guide the user
162 * in editing the file directly.
165 notmuch_config_open (void *ctx,
166 const char *filename,
167 notmuch_bool_t *is_new_ret)
169 GError *error = NULL;
175 notmuch_config_t *config = talloc (ctx, notmuch_config_t);
176 if (config == NULL) {
177 fprintf (stderr, "Out of memory.\n");
181 talloc_set_destructor (config, notmuch_config_destructor);
184 config->filename = talloc_strdup (config, filename);
186 config->filename = talloc_asprintf (config, "%s/.notmuch-config",
189 config->key_file = g_key_file_new ();
191 config->database_path = NULL;
192 config->user_name = NULL;
193 config->user_primary_email = NULL;
194 config->user_other_email = NULL;
195 config->user_other_email_length = 0;
197 if (! g_key_file_load_from_file (config->key_file,
199 G_KEY_FILE_KEEP_COMMENTS,
202 /* We are capable of dealing with a non-existent configuration
203 * file, so be silent about that. */
204 if (!(error->domain == G_FILE_ERROR &&
205 error->code == G_FILE_ERROR_NOENT))
207 fprintf (stderr, "Error reading configuration file %s: %s\n",
208 config->filename, error->message);
209 talloc_free (config);
210 g_error_free (error);
214 g_error_free (error);
218 if (notmuch_config_get_database_path (config) == NULL) {
219 char *path = talloc_asprintf (config, "%s/mail",
221 notmuch_config_set_database_path (config, path);
225 if (notmuch_config_get_user_name (config) == NULL) {
226 char *name = get_name_from_passwd_file (config);
227 notmuch_config_set_user_name (config, name);
231 if (notmuch_config_get_user_primary_email (config) == NULL) {
232 char *email = getenv ("EMAIL");
234 notmuch_config_set_user_primary_email (config, email);
237 struct hostent *hostent;
238 const char *domainname;
240 char *username = get_username_from_passwd_file (config);
242 gethostname (hostname, 256);
243 hostname[255] = '\0';
245 hostent = gethostbyname (hostname);
246 if (hostent && (domainname = strchr (hostent->h_name, '.')))
249 domainname = "(none)";
251 email = talloc_asprintf (config, "%s@%s.%s",
252 username, hostname, domainname);
254 notmuch_config_set_user_primary_email (config, email);
256 talloc_free (username);
261 /* When we create a new configuration file here, we add some
262 * comments to help the user understand what can be done. */
264 g_key_file_set_comment (config->key_file, NULL, NULL,
265 toplevel_config_comment, NULL);
266 g_key_file_set_comment (config->key_file, "database", NULL,
267 database_config_comment, NULL);
268 g_key_file_set_comment (config->key_file, "user", NULL,
269 user_config_comment, NULL);
273 *is_new_ret = is_new;
278 /* Close the given notmuch_config_t object, freeing all resources.
280 * Note: Any changes made to the configuration are *not* saved by this
281 * function. To save changes, call notmuch_config_save before
282 * notmuch_config_close.
285 notmuch_config_close (notmuch_config_t *config)
287 talloc_free (config);
290 /* Save any changes made to the notmuch configuration.
292 * Any comments originally in the file will be preserved.
294 * Returns 0 if successful, and 1 in case of any error, (after
295 * printing a description of the error to stderr).
298 notmuch_config_save (notmuch_config_t *config)
302 GError *error = NULL;
304 data = g_key_file_to_data (config->key_file, &length, NULL);
306 fprintf (stderr, "Out of memory.\n");
310 if (! g_file_set_contents (config->filename, data, length, &error)) {
311 fprintf (stderr, "Error saving configuration to %s: %s\n",
312 config->filename, error->message);
313 g_error_free (error);
321 notmuch_config_get_database_path (notmuch_config_t *config)
325 if (config->database_path == NULL) {
326 path = g_key_file_get_string (config->key_file,
327 "database", "path", NULL);
329 config->database_path = talloc_strdup (config, path);
334 return config->database_path;
338 notmuch_config_set_database_path (notmuch_config_t *config,
339 const char *database_path)
341 g_key_file_set_string (config->key_file,
342 "database", "path", database_path);
344 talloc_free (config->database_path);
345 config->database_path = NULL;
349 notmuch_config_get_user_name (notmuch_config_t *config)
353 if (config->user_name == NULL) {
354 name = g_key_file_get_string (config->key_file,
355 "user", "name", NULL);
357 config->user_name = talloc_strdup (config, name);
362 return config->user_name;
366 notmuch_config_set_user_name (notmuch_config_t *config,
367 const char *user_name)
369 g_key_file_set_string (config->key_file,
370 "user", "name", user_name);
372 talloc_free (config->user_name);
373 config->user_name = NULL;
377 notmuch_config_get_user_primary_email (notmuch_config_t *config)
381 if (config->user_primary_email == NULL) {
382 email = g_key_file_get_string (config->key_file,
383 "user", "primary_email", NULL);
385 config->user_primary_email = talloc_strdup (config, email);
390 return config->user_primary_email;
394 notmuch_config_set_user_primary_email (notmuch_config_t *config,
395 const char *primary_email)
397 g_key_file_set_string (config->key_file,
398 "user", "primary_email", primary_email);
400 talloc_free (config->user_primary_email);
401 config->user_primary_email = NULL;
405 notmuch_config_get_user_other_email (notmuch_config_t *config,
409 size_t emails_length;
412 if (config->user_other_email == NULL) {
413 emails = g_key_file_get_string_list (config->key_file,
414 "user", "other_email",
415 &emails_length, NULL);
417 config->user_other_email = talloc_size (config,
419 (emails_length + 1));
420 for (i = 0; i < emails_length; i++)
421 config->user_other_email[i] = talloc_strdup (config->user_other_email,
423 config->user_other_email[i] = NULL;
427 config->user_other_email_length = emails_length;
431 *length = config->user_other_email_length;
432 return config->user_other_email;
436 notmuch_config_set_user_other_email (notmuch_config_t *config,
437 const char *other_email[],
440 g_key_file_set_string_list (config->key_file,
441 "user", "other_email",
442 other_email, length);
444 talloc_free (config->user_other_email);
445 config->user_other_email = NULL;