X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-config.c;h=483d5c638e0e68d4a991aca9904c7336c8cc1a8a;hp=248149c85de0ee0401816537ce84b1adad5a88f0;hb=d9d3d3e6f06a76dc0fbe24c9655b64acfcd4b9e4;hpb=6bd01e1b340f6a209dde64471bc9d7137511dada

diff --git a/notmuch-config.c b/notmuch-config.c
index 248149c8..483d5c63 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"
@@ -53,6 +61,14 @@ static const char user_config_comment[] =
     " recipient list of replies, and will set the From address based on the\n"
     " address to which the original email was addressed.\n";
 
+static const char maildir_config_comment[] =
+    " Maildir compatibility configuration\n"
+    "\n"
+    " Here you can configure whether notmuch will synchronize its tags with\n"
+    " maildir flags."
+    "\n"
+    "\tsynchronize_flags      Valid values are true and false.\n";
+
 struct _notmuch_config {
     char *filename;
     GKeyFile *key_file;
@@ -60,10 +76,15 @@ 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;
+    notmuch_bool_t maildir_sync;
 };
 
+#define MAILDIR_SYNC_UNDEF ((notmuch_bool_t)-1)
+
 static int
 notmuch_config_destructor (notmuch_config_t *config)
 {
@@ -80,8 +101,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 +134,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, "");
@@ -115,34 +153,42 @@ 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.
+ *
+ *	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,
@@ -151,6 +197,12 @@ notmuch_config_open (void *ctx,
 {
     GError *error = NULL;
     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;
+    int file_had_maildir_group;
 
     if (is_new_ret)
 	*is_new_ret = 0;
@@ -163,11 +215,14 @@ notmuch_config_open (void *ctx,
     
     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 ();
 
@@ -176,26 +231,54 @@ notmuch_config_open (void *ctx,
     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;
+    config->maildir_sync = MAILDIR_SYNC_UNDEF;
 
     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;
 	}
-
-	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");
+    file_had_maildir_group = g_key_file_has_group (config->key_file, "maildir");
+
+
     if (notmuch_config_get_database_path (config) == NULL) {
 	char *path = talloc_asprintf (config, "%s/mail",
 				      getenv ("HOME"));
@@ -239,17 +322,48 @@ notmuch_config_open (void *ctx,
 	}
     }
 
-    /* When we create a new configuration file here, we  add some
-     * comments to help the user understand what can be done. */
-    if (is_new) {
+    if (notmuch_config_get_new_tags (config, &tmp) == NULL) {
+        const char *tags[] = { "unread", "inbox" };
+	notmuch_config_set_new_tags (config, tags, 2);
+    }
+
+    if (notmuch_config_get_maildir_sync (config) == MAILDIR_SYNC_UNDEF) {
+	notmuch_config_set_maildir_sync (config, FALSE);
+    }
+
+    /* 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 (! file_had_maildir_group)
+    {
+	g_key_file_set_comment (config->key_file, "maildir", NULL,
+				maildir_config_comment, NULL);
+    }
+
     if (is_new_ret)
 	*is_new_ret = is_new;
 
@@ -291,9 +405,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;
 }
 
@@ -381,7 +498,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)
 {
@@ -424,3 +541,214 @@ 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;
+}
+
+/* Given a configuration item of the form <group>.<key> return the
+ * component group and key. If any error occurs, print a message on
+ * stderr and return 1. Otherwise, return 0.
+ *
+ * Note: This function modifies the original 'item' string.
+ */
+static int
+_item_split (char *item, char **group, char **key)
+{
+    char *period;
+
+    *group = item;
+
+    period = index (item, '.');
+    if (period == NULL || *(period+1) == '\0') {
+	fprintf (stderr,
+		 "Invalid configuration name: %s\n"
+		 "(Should be of the form <section>.<item>)\n", item);
+	return 1;
+    }
+
+    *period = '\0';
+    *key = period + 1;
+
+    return 0;
+}
+
+static int
+notmuch_config_command_get (void *ctx, char *item)
+{
+    notmuch_config_t *config;
+
+    config = notmuch_config_open (ctx, NULL, NULL);
+    if (config == NULL)
+	return 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 {
+	char **value;
+	size_t i, length;
+	char *group, *key;
+
+	if (_item_split (item, &group, &key))
+	    return 1;
+
+	value = g_key_file_get_string_list (config->key_file,
+					    group, key,
+					    &length, NULL);
+	if (value == NULL) {
+	    fprintf (stderr, "Unknown configuration item: %s.%s\n",
+		     group, key);
+	    return 1;
+	}
+
+	for (i = 0; i < length; i++)
+	    printf ("%s\n", value[i]);
+
+	free (value);
+    }
+
+    notmuch_config_close (config);
+
+    return 0;
+}
+
+static int
+notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[])
+{
+    notmuch_config_t *config;
+    char *group, *key;
+    int ret;
+
+    if (_item_split (item, &group, &key))
+	return 1;
+
+    config = notmuch_config_open (ctx, NULL, NULL);
+    if (config == NULL)
+	return 1;
+
+    /* With only the name of an item, we clear it from the
+     * configuration file.
+     *
+     * With a single value, we set it as a string.
+     *
+     * With multiple values, we set them as a string list.
+     */
+    switch (argc) {
+    case 0:
+	g_key_file_remove_key (config->key_file, group, key, NULL);
+	break;
+    case 1:
+	g_key_file_set_string (config->key_file, group, key, argv[0]);
+	break;
+    default:
+	g_key_file_set_string_list (config->key_file, group, key,
+				    (const gchar **) argv, argc);
+	break;
+    }
+
+    ret = notmuch_config_save (config);
+    notmuch_config_close (config);
+
+    return ret;
+}
+
+int
+notmuch_config_command (void *ctx, int argc, char *argv[])
+{
+    if (argc < 2) {
+	fprintf (stderr, "Error: notmuch config requires at least two arguments.\n");
+	return 1;
+    }
+
+    if (strcmp (argv[0], "get") == 0)
+	return notmuch_config_command_get (ctx, argv[1]);
+    else if (strcmp (argv[0], "set") == 0)
+	return notmuch_config_command_set (ctx, argv[1], argc - 2, argv + 2);
+
+    fprintf (stderr, "Unrecognized argument for notmuch config: %s\n",
+	     argv[0]);
+    return 1;
+}
+
+notmuch_bool_t
+notmuch_config_get_maildir_sync (notmuch_config_t *config)
+{
+    GError *err = NULL;
+    if (config->maildir_sync == MAILDIR_SYNC_UNDEF) {
+	config->maildir_sync =
+	    g_key_file_get_boolean (config->key_file,
+				    "maildir", "synchronize_flags", &err);
+	if (err) {
+	    config->maildir_sync = MAILDIR_SYNC_UNDEF;
+	    g_error_free (err);
+	}
+    }
+    return config->maildir_sync;
+}
+
+void
+notmuch_config_set_maildir_sync (notmuch_config_t *config,
+				 notmuch_bool_t maildir_sync)
+{
+    g_key_file_set_boolean (config->key_file,
+			    "maildir", "synchronize_flags", maildir_sync);
+    config->maildir_sync = maildir_sync;
+}