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 new_config_comment[] =
41 " Configuration for \"notmuch new\"\n"
43 " The following options are supported here:\n"
45 "\ttags A list (separated by ';') of the tags that will be\n"
46 "\t added to all messages incorporated by \"notmuch new\".\n";
48 static const char user_config_comment[] =
49 " User configuration\n"
51 " Here is where you can let notmuch know how you would like to be\n"
52 " addressed. Valid settings are\n"
54 "\tname Your full name.\n"
55 "\tprimary_email Your primary email address.\n"
56 "\tother_email A list (separated by ';') of other email addresses\n"
57 "\t at which you receive email.\n"
59 " Notmuch will use the various email addresses configured here when\n"
60 " formatting replies. It will avoid including your own addresses in the\n"
61 " recipient list of replies, and will set the From address based on the\n"
62 " address to which the original email was addressed.\n";
64 struct _notmuch_config {
70 char *user_primary_email;
71 const char **user_other_email;
72 size_t user_other_email_length;
73 const char **new_tags;
74 size_t new_tags_length;
78 notmuch_config_destructor (notmuch_config_t *config)
81 g_key_file_free (config->key_file);
87 get_name_from_passwd_file (void *ctx)
89 long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
90 char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
91 struct passwd passwd, *ignored;
95 if (pw_buf_size == -1) pw_buf_size = 64;
97 while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
98 pw_buf_size, &ignored)) == ERANGE) {
99 pw_buf_size = pw_buf_size * 2;
100 pw_buf = talloc_zero_size(ctx, pw_buf_size);
104 char *comma = strchr (passwd.pw_gecos, ',');
106 name = talloc_strndup (ctx, passwd.pw_gecos,
107 comma - passwd.pw_gecos);
109 name = talloc_strdup (ctx, passwd.pw_gecos);
111 name = talloc_strdup (ctx, "");
114 talloc_free (pw_buf);
120 get_username_from_passwd_file (void *ctx)
122 long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
123 char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
124 struct passwd passwd, *ignored;
128 if (pw_buf_size == -1) pw_buf_size = 64;
129 while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
130 pw_buf_size, &ignored)) == ERANGE) {
131 pw_buf_size = pw_buf_size * 2;
132 pw_buf = talloc_zero_size(ctx, pw_buf_size);
136 name = talloc_strdup (ctx, passwd.pw_name);
138 name = talloc_strdup (ctx, "");
140 talloc_free (pw_buf);
145 /* Open the named notmuch configuration file. If the filename is NULL,
146 * the value of the environment variable $NOTMUCH_CONFIG will be used.
147 * If $NOTMUCH_CONFIG is unset, the default configuration file
148 * ($HOME/.notmuch-config) will be used.
150 * If any error occurs, (out of memory, or a permission-denied error,
151 * etc.), this function will print a message to stderr and return
154 * FILE NOT FOUND: When the specified configuration file (whether from
155 * 'filename' or the $NOTMUCH_CONFIG environment variable) does not
156 * exist, the behavior of this function depends on the 'is_new_ret'
159 * If is_new_ret is NULL, then a "file not found" message will be
160 * printed to stderr and NULL will be returned.
162 * If is_new_ret is non-NULL then a default configuration will be
163 * returned and *is_new_ret will be set to 1 on return so that
164 * the caller can recognize this case.
166 * These default configuration settings are determined as
169 * database_path: $HOME/mail
171 * user_name: From /etc/passwd
173 * user_primary_mail: $EMAIL variable if set, otherwise
174 * constructed from the username and
175 * hostname of the current machine.
177 * user_other_email: Not set.
179 * The default configuration also contains comments to guide the
180 * user in editing the file directly.
183 notmuch_config_open (void *ctx,
184 const char *filename,
185 notmuch_bool_t *is_new_ret)
187 GError *error = NULL;
190 char *notmuch_config_env = NULL;
191 int file_had_database_group;
192 int file_had_new_group;
193 int file_had_user_group;
198 notmuch_config_t *config = talloc (ctx, notmuch_config_t);
199 if (config == NULL) {
200 fprintf (stderr, "Out of memory.\n");
204 talloc_set_destructor (config, notmuch_config_destructor);
207 config->filename = talloc_strdup (config, filename);
208 } else if ((notmuch_config_env = getenv ("NOTMUCH_CONFIG"))) {
209 config->filename = talloc_strdup (config, notmuch_config_env);
211 config->filename = talloc_asprintf (config, "%s/.notmuch-config",
215 config->key_file = g_key_file_new ();
217 config->database_path = NULL;
218 config->user_name = NULL;
219 config->user_primary_email = NULL;
220 config->user_other_email = NULL;
221 config->user_other_email_length = 0;
222 config->new_tags = NULL;
223 config->new_tags_length = 0;
225 if (! g_key_file_load_from_file (config->key_file,
227 G_KEY_FILE_KEEP_COMMENTS,
230 /* If the caller passed a non-NULL value for is_new_ret, then
231 * the caller is prepared for a default configuration file in
232 * the case of FILE NOT FOUND. Otherwise, any read failure is
236 error->domain == G_FILE_ERROR &&
237 error->code == G_FILE_ERROR_NOENT)
239 g_error_free (error);
244 fprintf (stderr, "Error reading configuration file %s: %s\n",
245 config->filename, error->message);
246 talloc_free (config);
247 g_error_free (error);
252 /* Whenever we know of configuration sections that don't appear in
253 * the configuration file, we add some comments to help the user
254 * understand what can be done.
256 * It would be convenient to just add those comments now, but
257 * apparently g_key_file will clear any comments when keys are
258 * added later that create the groups. So we have to check for the
259 * groups now, but add the comments only after setting all of our
262 file_had_database_group = g_key_file_has_group (config->key_file,
264 file_had_new_group = g_key_file_has_group (config->key_file, "new");
265 file_had_user_group = g_key_file_has_group (config->key_file, "user");
268 if (notmuch_config_get_database_path (config) == NULL) {
269 char *path = talloc_asprintf (config, "%s/mail",
271 notmuch_config_set_database_path (config, path);
275 if (notmuch_config_get_user_name (config) == NULL) {
276 char *name = get_name_from_passwd_file (config);
277 notmuch_config_set_user_name (config, name);
281 if (notmuch_config_get_user_primary_email (config) == NULL) {
282 char *email = getenv ("EMAIL");
284 notmuch_config_set_user_primary_email (config, email);
287 struct hostent *hostent;
288 const char *domainname;
290 char *username = get_username_from_passwd_file (config);
292 gethostname (hostname, 256);
293 hostname[255] = '\0';
295 hostent = gethostbyname (hostname);
296 if (hostent && (domainname = strchr (hostent->h_name, '.')))
299 domainname = "(none)";
301 email = talloc_asprintf (config, "%s@%s.%s",
302 username, hostname, domainname);
304 notmuch_config_set_user_primary_email (config, email);
306 talloc_free (username);
311 if (notmuch_config_get_new_tags (config, &tmp) == NULL) {
312 const char *tags[] = { "unread", "inbox" };
313 notmuch_config_set_new_tags (config, tags, 2);
316 /* Whenever we know of configuration sections that don't appear in
317 * the configuration file, we add some comments to help the user
318 * understand what can be done. */
321 g_key_file_set_comment (config->key_file, NULL, NULL,
322 toplevel_config_comment, NULL);
325 if (! file_had_database_group)
327 g_key_file_set_comment (config->key_file, "database", NULL,
328 database_config_comment, NULL);
331 if (! file_had_new_group)
333 g_key_file_set_comment (config->key_file, "new", NULL,
334 new_config_comment, NULL);
337 if (! file_had_user_group)
339 g_key_file_set_comment (config->key_file, "user", NULL,
340 user_config_comment, NULL);
344 *is_new_ret = is_new;
349 /* Close the given notmuch_config_t object, freeing all resources.
351 * Note: Any changes made to the configuration are *not* saved by this
352 * function. To save changes, call notmuch_config_save before
353 * notmuch_config_close.
356 notmuch_config_close (notmuch_config_t *config)
358 talloc_free (config);
361 /* Save any changes made to the notmuch configuration.
363 * Any comments originally in the file will be preserved.
365 * Returns 0 if successful, and 1 in case of any error, (after
366 * printing a description of the error to stderr).
369 notmuch_config_save (notmuch_config_t *config)
373 GError *error = NULL;
375 data = g_key_file_to_data (config->key_file, &length, NULL);
377 fprintf (stderr, "Out of memory.\n");
381 if (! g_file_set_contents (config->filename, data, length, &error)) {
382 fprintf (stderr, "Error saving configuration to %s: %s\n",
383 config->filename, error->message);
384 g_error_free (error);
394 notmuch_config_get_database_path (notmuch_config_t *config)
398 if (config->database_path == NULL) {
399 path = g_key_file_get_string (config->key_file,
400 "database", "path", NULL);
402 config->database_path = talloc_strdup (config, path);
407 return config->database_path;
411 notmuch_config_set_database_path (notmuch_config_t *config,
412 const char *database_path)
414 g_key_file_set_string (config->key_file,
415 "database", "path", database_path);
417 talloc_free (config->database_path);
418 config->database_path = NULL;
422 notmuch_config_get_user_name (notmuch_config_t *config)
426 if (config->user_name == NULL) {
427 name = g_key_file_get_string (config->key_file,
428 "user", "name", NULL);
430 config->user_name = talloc_strdup (config, name);
435 return config->user_name;
439 notmuch_config_set_user_name (notmuch_config_t *config,
440 const char *user_name)
442 g_key_file_set_string (config->key_file,
443 "user", "name", user_name);
445 talloc_free (config->user_name);
446 config->user_name = NULL;
450 notmuch_config_get_user_primary_email (notmuch_config_t *config)
454 if (config->user_primary_email == NULL) {
455 email = g_key_file_get_string (config->key_file,
456 "user", "primary_email", NULL);
458 config->user_primary_email = talloc_strdup (config, email);
463 return config->user_primary_email;
467 notmuch_config_set_user_primary_email (notmuch_config_t *config,
468 const char *primary_email)
470 g_key_file_set_string (config->key_file,
471 "user", "primary_email", primary_email);
473 talloc_free (config->user_primary_email);
474 config->user_primary_email = NULL;
478 notmuch_config_get_user_other_email (notmuch_config_t *config,
482 size_t emails_length;
485 if (config->user_other_email == NULL) {
486 emails = g_key_file_get_string_list (config->key_file,
487 "user", "other_email",
488 &emails_length, NULL);
490 config->user_other_email = talloc_size (config,
492 (emails_length + 1));
493 for (i = 0; i < emails_length; i++)
494 config->user_other_email[i] = talloc_strdup (config->user_other_email,
496 config->user_other_email[i] = NULL;
500 config->user_other_email_length = emails_length;
504 *length = config->user_other_email_length;
505 return config->user_other_email;
509 notmuch_config_set_user_other_email (notmuch_config_t *config,
510 const char *other_email[],
513 g_key_file_set_string_list (config->key_file,
514 "user", "other_email",
515 other_email, length);
517 talloc_free (config->user_other_email);
518 config->user_other_email = NULL;
522 notmuch_config_get_new_tags (notmuch_config_t *config,
529 if (config->new_tags == NULL) {
530 tags = g_key_file_get_string_list (config->key_file,
534 config->new_tags = talloc_size (config,
537 for (i = 0; i < tags_length; i++)
538 config->new_tags[i] = talloc_strdup (config->new_tags,
540 config->new_tags[i] = NULL;
544 config->new_tags_length = tags_length;
548 *length = config->new_tags_length;
549 return config->new_tags;
553 notmuch_config_set_new_tags (notmuch_config_t *config,
554 const char *new_tags[],
557 g_key_file_set_string_list (config->key_file,
561 talloc_free (config->new_tags);
562 config->new_tags = NULL;
565 /* Given a configuration item of the form <group>.<key> return the
566 * component group and key. If any error occurs, print a message on
567 * stderr and return 1. Otherwise, return 0.
569 * Note: This function modifies the original 'item' string.
572 _item_split (char *item, char **group, char **key)
578 period = index (item, '.');
579 if (period == NULL || *(period+1) == '\0') {
581 "Invalid configuration name: %s\n"
582 "(Should be of the form <section>.<item>)\n", item);
593 notmuch_config_command_get (void *ctx, char *item)
595 notmuch_config_t *config;
597 config = notmuch_config_open (ctx, NULL, NULL);
601 if (strcmp(item, "database.path") == 0) {
602 printf ("%s\n", notmuch_config_get_database_path (config));
603 } else if (strcmp(item, "user.name") == 0) {
604 printf ("%s\n", notmuch_config_get_user_name (config));
605 } else if (strcmp(item, "user.primary_email") == 0) {
606 printf ("%s\n", notmuch_config_get_user_primary_email (config));
607 } else if (strcmp(item, "user.other_email") == 0) {
608 const char **other_email;
611 other_email = notmuch_config_get_user_other_email (config, &length);
612 for (i = 0; i < length; i++)
613 printf ("%s\n", other_email[i]);
614 } else if (strcmp(item, "new.tags") == 0) {
618 tags = notmuch_config_get_new_tags (config, &length);
619 for (i = 0; i < length; i++)
620 printf ("%s\n", tags[i]);
626 if (_item_split (item, &group, &key))
629 value = g_key_file_get_string_list (config->key_file,
633 fprintf (stderr, "Unknown configuration item: %s.%s\n",
638 for (i = 0; i < length; i++)
639 printf ("%s\n", value[i]);
644 notmuch_config_close (config);
650 notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[])
652 notmuch_config_t *config;
656 if (_item_split (item, &group, &key))
659 config = notmuch_config_open (ctx, NULL, NULL);
663 /* With only the name of an item, we clear it from the
664 * configuration file.
666 * With a single value, we set it as a string.
668 * With multiple values, we set them as a string list.
672 g_key_file_remove_key (config->key_file, group, key, NULL);
675 g_key_file_set_string (config->key_file, group, key, argv[0]);
678 g_key_file_set_string_list (config->key_file, group, key,
679 (const gchar **) argv, argc);
683 ret = notmuch_config_save (config);
684 notmuch_config_close (config);
690 notmuch_config_command (void *ctx, int argc, char *argv[])
693 fprintf (stderr, "Error: notmuch config requires at least two arguments.\n");
697 if (strcmp (argv[0], "get") == 0)
698 return notmuch_config_command_get (ctx, argv[1]);
699 else if (strcmp (argv[0], "set") == 0)
700 return notmuch_config_command_set (ctx, argv[1], argc - 2, argv + 2);
702 fprintf (stderr, "Unrecognized argument for notmuch config: %s\n",