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. If the filename is NULL,
136 * the value of the environment variable $NOTMUCH_CONFIG will be used.
137 * If $NOTMUCH_CONFIG is unset, the default configuration file
138 * ($HOME/.notmuch-config) will be used.
140 * If any error occurs, (out of memory, or a permission-denied error,
141 * etc.), this function will print a message to stderr and return
144 * Note: It is *not* an error if the specified configuration file does
145 * not exist. In this case, a default configuration will be created
146 * and returned. Subsequently calling notmuch_config_save will cause
147 * the configuration to be written to the filename specified at the
148 * time of notmuch_config_open.
150 * The default configuration settings are determined as follows:
152 * database_path: $HOME/mail
154 * user_name: From /etc/passwd
156 * user_primary_mail: $EMAIL variable if set, otherwise
157 * constructed from the username and
158 * hostname of the current machine.
160 * user_other_email: Not set.
162 * The default configuration also contains comments to guide the user
163 * in editing the file directly.
166 notmuch_config_open (void *ctx,
167 const char *filename,
168 notmuch_bool_t *is_new_ret)
170 GError *error = NULL;
172 char *notmuch_config_env = NULL;
177 notmuch_config_t *config = talloc (ctx, notmuch_config_t);
178 if (config == NULL) {
179 fprintf (stderr, "Out of memory.\n");
183 talloc_set_destructor (config, notmuch_config_destructor);
186 config->filename = talloc_strdup (config, filename);
187 } else if ((notmuch_config_env = getenv ("NOTMUCH_CONFIG"))) {
188 config->filename = talloc_strdup (config, notmuch_config_env);
190 config->filename = talloc_asprintf (config, "%s/.notmuch-config",
194 config->key_file = g_key_file_new ();
196 config->database_path = NULL;
197 config->user_name = NULL;
198 config->user_primary_email = NULL;
199 config->user_other_email = NULL;
200 config->user_other_email_length = 0;
202 if (! g_key_file_load_from_file (config->key_file,
204 G_KEY_FILE_KEEP_COMMENTS,
207 /* We are capable of dealing with a non-existent configuration
208 * file, so be silent about that (unless the user had set a
209 * non-default configuration file with the NOTMUCH_CONFIG
212 if (notmuch_config_env ||
213 !(error->domain == G_FILE_ERROR &&
214 error->code == G_FILE_ERROR_NOENT))
216 fprintf (stderr, "Error reading configuration file %s: %s\n",
217 config->filename, error->message);
218 talloc_free (config);
219 g_error_free (error);
223 g_error_free (error);
227 if (notmuch_config_get_database_path (config) == NULL) {
228 char *path = talloc_asprintf (config, "%s/mail",
230 notmuch_config_set_database_path (config, path);
234 if (notmuch_config_get_user_name (config) == NULL) {
235 char *name = get_name_from_passwd_file (config);
236 notmuch_config_set_user_name (config, name);
240 if (notmuch_config_get_user_primary_email (config) == NULL) {
241 char *email = getenv ("EMAIL");
243 notmuch_config_set_user_primary_email (config, email);
246 struct hostent *hostent;
247 const char *domainname;
249 char *username = get_username_from_passwd_file (config);
251 gethostname (hostname, 256);
252 hostname[255] = '\0';
254 hostent = gethostbyname (hostname);
255 if (hostent && (domainname = strchr (hostent->h_name, '.')))
258 domainname = "(none)";
260 email = talloc_asprintf (config, "%s@%s.%s",
261 username, hostname, domainname);
263 notmuch_config_set_user_primary_email (config, email);
265 talloc_free (username);
270 /* When we create a new configuration file here, we add some
271 * comments to help the user understand what can be done. */
273 g_key_file_set_comment (config->key_file, NULL, NULL,
274 toplevel_config_comment, NULL);
275 g_key_file_set_comment (config->key_file, "database", NULL,
276 database_config_comment, NULL);
277 g_key_file_set_comment (config->key_file, "user", NULL,
278 user_config_comment, NULL);
282 *is_new_ret = is_new;
287 /* Close the given notmuch_config_t object, freeing all resources.
289 * Note: Any changes made to the configuration are *not* saved by this
290 * function. To save changes, call notmuch_config_save before
291 * notmuch_config_close.
294 notmuch_config_close (notmuch_config_t *config)
296 talloc_free (config);
299 /* Save any changes made to the notmuch configuration.
301 * Any comments originally in the file will be preserved.
303 * Returns 0 if successful, and 1 in case of any error, (after
304 * printing a description of the error to stderr).
307 notmuch_config_save (notmuch_config_t *config)
311 GError *error = NULL;
313 data = g_key_file_to_data (config->key_file, &length, NULL);
315 fprintf (stderr, "Out of memory.\n");
319 if (! g_file_set_contents (config->filename, data, length, &error)) {
320 fprintf (stderr, "Error saving configuration to %s: %s\n",
321 config->filename, error->message);
322 g_error_free (error);
332 notmuch_config_get_database_path (notmuch_config_t *config)
336 if (config->database_path == NULL) {
337 path = g_key_file_get_string (config->key_file,
338 "database", "path", NULL);
340 config->database_path = talloc_strdup (config, path);
345 return config->database_path;
349 notmuch_config_set_database_path (notmuch_config_t *config,
350 const char *database_path)
352 g_key_file_set_string (config->key_file,
353 "database", "path", database_path);
355 talloc_free (config->database_path);
356 config->database_path = NULL;
360 notmuch_config_get_user_name (notmuch_config_t *config)
364 if (config->user_name == NULL) {
365 name = g_key_file_get_string (config->key_file,
366 "user", "name", NULL);
368 config->user_name = talloc_strdup (config, name);
373 return config->user_name;
377 notmuch_config_set_user_name (notmuch_config_t *config,
378 const char *user_name)
380 g_key_file_set_string (config->key_file,
381 "user", "name", user_name);
383 talloc_free (config->user_name);
384 config->user_name = NULL;
388 notmuch_config_get_user_primary_email (notmuch_config_t *config)
392 if (config->user_primary_email == NULL) {
393 email = g_key_file_get_string (config->key_file,
394 "user", "primary_email", NULL);
396 config->user_primary_email = talloc_strdup (config, email);
401 return config->user_primary_email;
405 notmuch_config_set_user_primary_email (notmuch_config_t *config,
406 const char *primary_email)
408 g_key_file_set_string (config->key_file,
409 "user", "primary_email", primary_email);
411 talloc_free (config->user_primary_email);
412 config->user_primary_email = NULL;
416 notmuch_config_get_user_other_email (notmuch_config_t *config,
420 size_t emails_length;
423 if (config->user_other_email == NULL) {
424 emails = g_key_file_get_string_list (config->key_file,
425 "user", "other_email",
426 &emails_length, NULL);
428 config->user_other_email = talloc_size (config,
430 (emails_length + 1));
431 for (i = 0; i < emails_length; i++)
432 config->user_other_email[i] = talloc_strdup (config->user_other_email,
434 config->user_other_email[i] = NULL;
438 config->user_other_email_length = emails_length;
442 *length = config->user_other_email_length;
443 return config->user_other_email;
447 notmuch_config_set_user_other_email (notmuch_config_t *config,
448 const char *other_email[],
451 g_key_file_set_string_list (config->key_file,
452 "user", "other_email",
453 other_email, length);
455 talloc_free (config->user_other_email);
456 config->user_other_email = NULL;