" Notmuch will store its database within a sub-directory of the path\n"
" configured here named \".notmuch\".\n";
-static const char messages_config_comment[] =
- " Messages configuration\n"
+static const char new_config_comment[] =
+ " Configuration for \"notmuch new\"\n"
"\n"
- " The only value supported here is 'new_tags' which lists the tags that\n"
- " should be applied to new messages.\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"
char *user_primary_email;
char **user_other_email;
size_t user_other_email_length;
- char **new_tags;
+ const char **new_tags;
size_t new_tags_length;
};
* 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.
+ *
+ * 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.
*
- * The default configuration settings are determined as follows:
+ * These default configuration settings are determined as
+ * follows:
*
- * database_path: $HOME/mail
+ * database_path: $HOME/mail
*
- * user_name: From /etc/passwd
+ * user_name: From /etc/passwd
*
- * user_primary_mail: $EMAIL variable if set, otherwise
- * constructed from the username and
- * hostname of the current machine.
+ * user_primary_mail: $EMAIL variable if set, otherwise
+ * constructed from the username and
+ * hostname of the current machine.
*
- * user_other_email: Not set.
+ * user_other_email: Not set.
*
- * The default configuration also contains comments to guide the user
- * in editing the file directly.
+ * The default configuration also contains comments to guide the
+ * user in editing the file directly.
*/
notmuch_config_t *
notmuch_config_open (void *ctx,
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;
G_KEY_FILE_KEEP_COMMENTS,
&error))
{
- /* We are capable of dealing with a non-existent configuration
- * file, so be silent about that (unless the user had set a
- * non-default configuration file with the NOTMUCH_CONFIG
- * variable)
+ /* 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 (notmuch_config_env ||
- !(error->domain == G_FILE_ERROR &&
- error->code == G_FILE_ERROR_NOENT))
+ 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);
g_error_free (error);
return NULL;
}
-
- g_error_free (error);
- 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"));
notmuch_config_set_new_tags (config, tags, 2);
}
- /* When we create a new configuration file here, we add some
- * comments to help the user understand what can be done. */
- if (is_new) {
+ /* 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);
- g_key_file_set_comment (config->key_file, "messages", NULL,
- messages_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);
}
config->user_other_email = NULL;
}
-char **
+const char **
notmuch_config_get_new_tags (notmuch_config_t *config,
size_t *length)
{
if (config->new_tags == NULL) {
tags = g_key_file_get_string_list (config->key_file,
- "messages", "new_tags",
+ "new", "tags",
&tags_length, NULL);
if (tags) {
config->new_tags = talloc_size (config,
size_t length)
{
g_key_file_set_string_list (config->key_file,
- "messages", "new_tags",
+ "new", "tags",
new_tags, length);
talloc_free (config->new_tags);