X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-config.c;h=95430db104fce8583ac089f9a3e83f52c08901b0;hp=0dc2b1339f0ba5338ddd838c5917ec57b401c4f9;hb=bb5211684654b7cf54f842990a733a64fe01d612;hpb=305e76bc0ab2e7f3bd1ff2580e8d5dac8b4a7164 diff --git a/notmuch-config.c b/notmuch-config.c index 0dc2b133..95430db1 100644 --- a/notmuch-config.c +++ b/notmuch-config.c @@ -23,6 +23,36 @@ #include #include +static const char toplevel_config_comment[] = + " .notmuch-config - Configuration file for the notmuch mail system\n" + "\n" + " For more information about notmuch, see http://notmuchmail.org"; + +static const char database_config_comment[] = + " Database configuration\n" + "\n" + " The only value supported here is 'path' which should be the top-level\n" + " directory where your mail currently exists and to where mail will be\n" + " delivered in the future. Files should be individual email messages.\n" + " Notmuch will store its database within a sub-directory of the path\n" + " configured here named \".notmuch\".\n"; + +static const char user_config_comment[] = + " User configuration\n" + "\n" + " Here is where you can let notmuch know how you would like to be\n" + " addressed. Valid settings are\n" + "\n" + "\tname Your full name.\n" + "\tprimary_email Your primary email address.\n" + "\tother_email A list (separated by ';') of other email addresses\n" + "\t at which you receive email.\n" + "\n" + " Notmuch will use the various email addresses configured here when\n" + " formatting replies. It will avoid including your own addresses in the\n" + " recipient list of replies, and will set the From address based on the\n" + " address to which the original email was addressed.\n"; + struct _notmuch_config { char *filename; GKeyFile *key_file; @@ -50,8 +80,17 @@ get_name_from_passwd_file (void *ctx) char *pw_buf = talloc_zero_size (ctx, pw_buf_size); struct passwd passwd, *ignored; char *name; + int e; + + if (pw_buf_size == -1) pw_buf_size = 64; + + while ((e = getpwuid_r (getuid (), &passwd, pw_buf, + pw_buf_size, &ignored)) == ERANGE) { + pw_buf_size = pw_buf_size * 2; + pw_buf = talloc_zero_size(ctx, pw_buf_size); + } - if (getpwuid_r (getuid (), &passwd, pw_buf, pw_buf_size, &ignored) == 0) { + if (e == 0) { char *comma = strchr (passwd.pw_gecos, ','); if (comma) name = talloc_strndup (ctx, passwd.pw_gecos, @@ -74,8 +113,16 @@ get_username_from_passwd_file (void *ctx) char *pw_buf = talloc_zero_size (ctx, pw_buf_size); struct passwd passwd, *ignored; char *name; + int e; - if (getpwuid_r (getuid (), &passwd, pw_buf, pw_buf_size, &ignored) == 0) + if (pw_buf_size == -1) pw_buf_size = 64; + while ((e = getpwuid_r (getuid (), &passwd, pw_buf, + pw_buf_size, &ignored)) == ERANGE) { + pw_buf_size = pw_buf_size * 2; + pw_buf = talloc_zero_size(ctx, pw_buf_size); + } + + if (e == 0) name = talloc_strdup (ctx, passwd.pw_name); else name = talloc_strdup (ctx, ""); @@ -85,9 +132,10 @@ get_username_from_passwd_file (void *ctx) return name; } -/* Open the named notmuch configuration file. A filename of NULL will - * be interpreted as the default configuration file - * ($HOME/.notmuch-config). +/* Open the named notmuch configuration file. If the filename is NULL, + * the value of the environment variable $NOTMUCH_CONFIG will be used. + * If $NOTMUCH_CONFIG is unset, the default configuration file + * ($HOME/.notmuch-config) will be used. * * If any error occurs, (out of memory, or a permission-denied error, * etc.), this function will print a message to stderr and return @@ -115,9 +163,16 @@ get_username_from_passwd_file (void *ctx) * in editing the file directly. */ notmuch_config_t * -notmuch_config_open (void *ctx, const char *filename) +notmuch_config_open (void *ctx, + const char *filename, + notmuch_bool_t *is_new_ret) { GError *error = NULL; + int is_new = 0; + char *notmuch_config_env = NULL; + + if (is_new_ret) + *is_new_ret = 0; notmuch_config_t *config = talloc (ctx, notmuch_config_t); if (config == NULL) { @@ -127,11 +182,15 @@ notmuch_config_open (void *ctx, const char *filename) talloc_set_destructor (config, notmuch_config_destructor); - if (filename) + if (filename) { config->filename = talloc_strdup (config, filename); - else + } else if ((notmuch_config_env = getenv ("NOTMUCH_CONFIG"))) { + config->filename = talloc_strdup (config, notmuch_config_env); + notmuch_config_env = NULL; + } else { config->filename = talloc_asprintf (config, "%s/.notmuch-config", getenv ("HOME")); + } config->key_file = g_key_file_new (); @@ -154,8 +213,12 @@ notmuch_config_open (void *ctx, const char *filename) fprintf (stderr, "Error reading configuration file %s: %s\n", config->filename, error->message); talloc_free (config); + g_error_free (error); return NULL; } + + g_error_free (error); + is_new = 1; } if (notmuch_config_get_database_path (config) == NULL) { @@ -201,6 +264,20 @@ notmuch_config_open (void *ctx, const char *filename) } } + /* When we create a new configuration file here, we add some + * comments to help the user understand what can be done. */ + if (is_new) { + g_key_file_set_comment (config->key_file, NULL, NULL, + toplevel_config_comment, NULL); + g_key_file_set_comment (config->key_file, "database", NULL, + database_config_comment, NULL); + g_key_file_set_comment (config->key_file, "user", NULL, + user_config_comment, NULL); + } + + if (is_new_ret) + *is_new_ret = is_new; + return config; } @@ -239,9 +316,12 @@ notmuch_config_save (notmuch_config_t *config) if (! g_file_set_contents (config->filename, data, length, &error)) { fprintf (stderr, "Error saving configuration to %s: %s\n", config->filename, error->message); + g_error_free (error); + g_free (data); return 1; } + g_free (data); return 0; }