X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-config.c;h=2e81d1c22e4a27232d561f119b4962663c024fc0;hp=f7313bfaa055d300114845e0375308ddf1ff9cfa;hb=b9eac48c22f53f84ed1d9c1d8ca862a7b638c9ac;hpb=c884c30c30f97a857a0fae16d0d212632080361d diff --git a/notmuch-config.c b/notmuch-config.c index f7313bfa..2e81d1c2 100644 --- a/notmuch-config.c +++ b/notmuch-config.c @@ -37,6 +37,14 @@ static const char database_config_comment[] = " Notmuch will store its database within a sub-directory of the path\n" " configured here named \".notmuch\".\n"; +static const char new_config_comment[] = + " Configuration for \"notmuch new\"\n" + "\n" + " The following options are supported here:\n" + "\n" + "\ttags A list (separated by ';') of the tags that will be\n" + "\t added to all messages incorporated by \"notmuch new\".\n"; + static const char user_config_comment[] = " User configuration\n" "\n" @@ -60,8 +68,10 @@ struct _notmuch_config { char *database_path; char *user_name; char *user_primary_email; - char **user_other_email; + const char **user_other_email; size_t user_other_email_length; + const char **new_tags; + size_t new_tags_length; }; static int @@ -80,8 +90,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 (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) { char *comma = strchr (passwd.pw_gecos, ','); if (comma) name = talloc_strndup (ctx, passwd.pw_gecos, @@ -104,8 +123,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 (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) name = talloc_strdup (ctx, passwd.pw_name); else name = talloc_strdup (ctx, ""); @@ -115,40 +142,58 @@ 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 * NULL. * - * Note: It is *not* an error if the specified configuration file does - * not exist. In this case, a default configuration will be created - * and returned. Subsequently calling notmuch_config_save will cause - * the configuration to be written to the filename specified at the - * time of notmuch_config_open. + * FILE NOT FOUND: When the specified configuration file (whether from + * 'filename' or the $NOTMUCH_CONFIG environment variable) does not + * exist, the behavior of this function depends on the 'is_new_ret' + * variable. * - * The default configuration settings are determined as follows: + * If is_new_ret is NULL, then a "file not found" message will be + * printed to stderr and NULL will be returned. + + * If is_new_ret is non-NULL then a default configuration will be + * returned and *is_new_ret will be set to 1 on return so that + * the caller can recognize this case. * - * database_path: $HOME/mail + * These default configuration settings are determined as + * follows: * - * user_name: From /etc/passwd + * database_path: $HOME/mail * - * user_primary_mail: $EMAIL variable if set, otherwise - * constructed from the username and - * hostname of the current machine. + * user_name: From /etc/passwd * - * user_other_email: Not set. + * user_primary_mail: $EMAIL variable if set, otherwise + * constructed from the username and + * hostname of the current machine. * - * The default configuration also contains comments to guide the user - * in editing the file directly. + * user_other_email: Not set. + * + * The default configuration also contains comments to guide the + * user 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 config_file_is_new = 0; + int is_new = 0; + size_t tmp; + char *notmuch_config_env = NULL; + int file_had_database_group; + int file_had_new_group; + int file_had_user_group; + + if (is_new_ret) + *is_new_ret = 0; notmuch_config_t *config = talloc (ctx, notmuch_config_t); if (config == NULL) { @@ -158,11 +203,14 @@ 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); + } else { config->filename = talloc_asprintf (config, "%s/.notmuch-config", getenv ("HOME")); + } config->key_file = g_key_file_new (); @@ -171,26 +219,52 @@ notmuch_config_open (void *ctx, const char *filename) config->user_primary_email = NULL; config->user_other_email = NULL; config->user_other_email_length = 0; + config->new_tags = NULL; + config->new_tags_length = 0; if (! g_key_file_load_from_file (config->key_file, config->filename, G_KEY_FILE_KEEP_COMMENTS, &error)) { - /* We are capable of dealing with a non-existent configuration - * file, so be silent about that. */ - if (!(error->domain == G_FILE_ERROR && - error->code == G_FILE_ERROR_NOENT)) + /* If the caller passed a non-NULL value for is_new_ret, then + * the caller is prepared for a default configuration file in + * the case of FILE NOT FOUND. Otherwise, any read failure is + * an error. + */ + if (is_new_ret && + error->domain == G_FILE_ERROR && + error->code == G_FILE_ERROR_NOENT) + { + g_error_free (error); + is_new = 1; + } + else { fprintf (stderr, "Error reading configuration file %s: %s\n", config->filename, error->message); talloc_free (config); + g_error_free (error); return NULL; } - - config_file_is_new = 1; } + /* Whenever we know of configuration sections that don't appear in + * the configuration file, we add some comments to help the user + * understand what can be done. + * + * It would be convenient to just add those comments now, but + * apparently g_key_file will clear any comments when keys are + * added later that create the groups. So we have to check for the + * groups now, but add the comments only after setting all of our + * values. + */ + file_had_database_group = g_key_file_has_group (config->key_file, + "database"); + file_had_new_group = g_key_file_has_group (config->key_file, "new"); + file_had_user_group = g_key_file_has_group (config->key_file, "user"); + + if (notmuch_config_get_database_path (config) == NULL) { char *path = talloc_asprintf (config, "%s/mail", getenv ("HOME")); @@ -234,17 +308,41 @@ 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 (config_file_is_new) { + if (notmuch_config_get_new_tags (config, &tmp) == NULL) { + const char *tags[] = { "unread", "inbox" }; + notmuch_config_set_new_tags (config, tags, 2); + } + + /* Whenever we know of configuration sections that don't appear in + * the configuration file, 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); + } + + if (! file_had_database_group) + { g_key_file_set_comment (config->key_file, "database", NULL, database_config_comment, NULL); + } + + if (! file_had_new_group) + { + g_key_file_set_comment (config->key_file, "new", NULL, + new_config_comment, NULL); + } + + if (! file_had_user_group) + { 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; } @@ -283,9 +381,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; } @@ -373,7 +474,7 @@ notmuch_config_set_user_primary_email (notmuch_config_t *config, config->user_primary_email = NULL; } -char ** +const char ** notmuch_config_get_user_other_email (notmuch_config_t *config, size_t *length) { @@ -416,3 +517,101 @@ notmuch_config_set_user_other_email (notmuch_config_t *config, talloc_free (config->user_other_email); config->user_other_email = NULL; } + +const char ** +notmuch_config_get_new_tags (notmuch_config_t *config, + size_t *length) +{ + char **tags; + size_t tags_length; + unsigned int i; + + if (config->new_tags == NULL) { + tags = g_key_file_get_string_list (config->key_file, + "new", "tags", + &tags_length, NULL); + if (tags) { + config->new_tags = talloc_size (config, + sizeof (char *) * + (tags_length + 1)); + for (i = 0; i < tags_length; i++) + config->new_tags[i] = talloc_strdup (config->new_tags, + tags[i]); + config->new_tags[i] = NULL; + + g_strfreev (tags); + + config->new_tags_length = tags_length; + } + } + + *length = config->new_tags_length; + return config->new_tags; +} + +void +notmuch_config_set_new_tags (notmuch_config_t *config, + const char *new_tags[], + size_t length) +{ + g_key_file_set_string_list (config->key_file, + "new", "tags", + new_tags, length); + + talloc_free (config->new_tags); + config->new_tags = NULL; +} + +int +notmuch_config_command (void *ctx, int argc, char *argv[]) +{ + notmuch_config_t *config; + const char *item; + + if (argc != 2) { + fprintf (stderr, "Error: notmuch config requires two arguments.\n"); + return 1; + } + + if (strcmp (argv[0], "get")) { + fprintf (stderr, "Unrecognized argument for notmuch config: %s\n", + argv[0]); + return 1; + } + + config = notmuch_config_open (ctx, NULL, NULL); + if (config == NULL) + return 1; + + item = argv[1]; + + if (strcmp(item, "database.path") == 0) { + printf ("%s\n", notmuch_config_get_database_path (config)); + } else if (strcmp(item, "user.name") == 0) { + printf ("%s\n", notmuch_config_get_user_name (config)); + } else if (strcmp(item, "user.primary_email") == 0) { + printf ("%s\n", notmuch_config_get_user_primary_email (config)); + } else if (strcmp(item, "user.other_email") == 0) { + const char **other_email; + size_t i, length; + + other_email = notmuch_config_get_user_other_email (config, &length); + for (i = 0; i < length; i++) + printf ("%s\n", other_email[i]); + } else if (strcmp(item, "new.tags") == 0) { + const char **tags; + size_t i, length; + + tags = notmuch_config_get_new_tags (config, &length); + for (i = 0; i < length; i++) + printf ("%s\n", tags[i]); + } else { + fprintf (stderr, "Unknown configuration item: %s\n", + argv[1]); + return 1; + } + + notmuch_config_close (config); + + return 0; +}