]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-config.c
notmuch: Add a new "notmuch config" command for querying configuration.
[notmuch] / notmuch-config.c
index 95430db104fce8583ac089f9a3e83f52c08901b0..2e81d1c22e4a27232d561f119b4962663c024fc0 100644 (file)
@@ -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
@@ -141,26 +151,33 @@ get_username_from_passwd_file (void *ctx)
  * 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,
@@ -169,7 +186,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 +207,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,16 +219,27 @@ 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,
                                     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);
@@ -216,11 +247,24 @@ notmuch_config_open (void *ctx,
            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"));
@@ -264,13 +308,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);
     }
@@ -409,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)
 {
@@ -452,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;
+}