python: have docs reflect current return value behavior

[notmuch] / notmuch-config.c

diff --git a/notmuch-config.c b/notmuch-config.c
index 95430db104fce8583ac089f9a3e83f52c08901b0..58f83b0d299c8d4b6213758448bf1db69302b6b3 100644 (file)
--- 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"
@@ -62,6 +70,8 @@ struct _notmuch_config {
     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
@@ -169,7 +179,11 @@ 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;
 
     if (is_new_ret)
        *is_new_ret = 0;
@@ -186,7 +200,6 @@ notmuch_config_open (void *ctx,
        config->filename = talloc_strdup (config, filename);
     } 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"));
@@ -199,6 +212,8 @@ 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;
 
     if (! g_key_file_load_from_file (config->key_file,
                                     config->filename,
@@ -206,8 +221,12 @@ notmuch_config_open (void *ctx,
                                     &error))
     {
        /* We are capable of dealing with a non-existent configuration
-        * file, so be silent about that. */
-       if (!(error->domain == G_FILE_ERROR &&
+        * file, so be silent about that (unless the user had set a
+        * non-default configuration file with the NOTMUCH_CONFIG
+        * variable)
+        */
+       if (notmuch_config_env ||
+           !(error->domain == G_FILE_ERROR &&
              error->code == G_FILE_ERROR_NOENT))
        {
            fprintf (stderr, "Error reading configuration file %s: %s\n",
@@ -221,6 +240,22 @@ notmuch_config_open (void *ctx,
        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"));
@@ -264,13 +299,34 @@ 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);
+    }
+
+    /* 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);
     }
@@ -452,3 +508,48 @@ 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;
+}
+