" 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"
char *user_primary_email;
char **user_other_email;
size_t user_other_email_length;
+ const char **new_tags;
+ size_t new_tags_length;
};
static int
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,
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, "");
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.
+ *
+ * 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, 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) {
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 ();
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"));
}
}
- /* 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;
}
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;
}
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;
+}
+