]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-config.c
contrib: pick: Do not indent messages in the message pane
[notmuch] / notmuch-config.c
index 483d5c638e0e68d4a991aca9904c7336c8cc1a8a..3e37a2d654b5c57df4d3a39d07afe97b5e9095e6 100644 (file)
@@ -22,6 +22,7 @@
 
 #include <pwd.h>
 #include <netdb.h>
+#include <assert.h>
 
 static const char toplevel_config_comment[] =
     " .notmuch-config - Configuration file for the notmuch mail system\n"
@@ -43,7 +44,13 @@ static const char new_config_comment[] =
     " 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";
+    "\t        added to all messages incorporated by \"notmuch new\".\n"
+    "\n"
+    "\tignore  A list (separated by ';') of file and directory names\n"
+    "\t        that will not be searched for messages by \"notmuch new\".\n"
+    "\n"
+    "\t        NOTE: *Every* file/directory that goes by one of those names will\n"
+    "\t        be ignored, independent of its depth/location in the mail store.\n";
 
 static const char user_config_comment[] =
     " User configuration\n"
@@ -64,10 +71,34 @@ static const char user_config_comment[] =
 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."
+    " The following option is supported here:\n"
+    "\n"
+    "\tsynchronize_flags      Valid values are true and false.\n"
+    "\n"
+    "\tIf true, then the following maildir flags (in message filenames)\n"
+    "\twill be synchronized with the corresponding notmuch tags:\n"
+    "\n"
+    "\t\tFlag  Tag\n"
+    "\t\t----  -------\n"
+    "\t\tD     draft\n"
+    "\t\tF     flagged\n"
+    "\t\tP     passed\n"
+    "\t\tR     replied\n"
+    "\t\tS     unread (added when 'S' flag is not present)\n"
+    "\n"
+    "\tThe \"notmuch new\" command will notice flag changes in filenames\n"
+    "\tand update tags, while the \"notmuch tag\" and \"notmuch restore\"\n"
+    "\tcommands will notice tag changes and update flags in filenames\n";
+
+static const char search_config_comment[] =
+    " Search configuration\n"
+    "\n"
+    " The following option is supported here:\n"
     "\n"
-    "\tsynchronize_flags      Valid values are true and false.\n";
+    "\texclude_tags\n"
+    "\t\tA ;-separated list of tags that will be excluded from\n"
+    "\t\tsearch results by default.  Using an excluded tag in a\n"
+    "\t\tquery will override that exclusion.\n";
 
 struct _notmuch_config {
     char *filename;
@@ -80,11 +111,13 @@ struct _notmuch_config {
     size_t user_other_email_length;
     const char **new_tags;
     size_t new_tags_length;
-    notmuch_bool_t maildir_sync;
+    const char **new_ignore;
+    size_t new_ignore_length;
+    notmuch_bool_t maildir_synchronize_flags;
+    const char **search_exclude_tags;
+    size_t search_exclude_tags_length;
 };
 
-#define MAILDIR_SYNC_UNDEF ((notmuch_bool_t)-1)
-
 static int
 notmuch_config_destructor (notmuch_config_t *config)
 {
@@ -97,13 +130,15 @@ notmuch_config_destructor (notmuch_config_t *config)
 static char *
 get_name_from_passwd_file (void *ctx)
 {
-    long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
-    char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
+    long pw_buf_size;
+    char *pw_buf;
     struct passwd passwd, *ignored;
     char *name;
     int e;
 
+    pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
     if (pw_buf_size == -1) pw_buf_size = 64;
+    pw_buf = talloc_size (ctx, pw_buf_size);
 
     while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
                             pw_buf_size, &ignored)) == ERANGE) {
@@ -130,13 +165,16 @@ get_name_from_passwd_file (void *ctx)
 static char *
 get_username_from_passwd_file (void *ctx)
 {
-    long pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
-    char *pw_buf = talloc_zero_size (ctx, pw_buf_size);
+    long pw_buf_size;
+    char *pw_buf;
     struct passwd passwd, *ignored;
     char *name;
     int e;
 
+    pw_buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
     if (pw_buf_size == -1) pw_buf_size = 64;
+    pw_buf = talloc_zero_size (ctx, pw_buf_size);
+
     while ((e = getpwuid_r (getuid (), &passwd, pw_buf,
                             pw_buf_size, &ignored)) == ERANGE) {
         pw_buf_size = pw_buf_size * 2;
@@ -203,6 +241,7 @@ notmuch_config_open (void *ctx,
     int file_had_new_group;
     int file_had_user_group;
     int file_had_maildir_group;
+    int file_had_search_group;
 
     if (is_new_ret)
        *is_new_ret = 0;
@@ -233,7 +272,11 @@ notmuch_config_open (void *ctx,
     config->user_other_email_length = 0;
     config->new_tags = NULL;
     config->new_tags_length = 0;
-    config->maildir_sync = MAILDIR_SYNC_UNDEF;
+    config->new_ignore = NULL;
+    config->new_ignore_length = 0;
+    config->maildir_synchronize_flags = TRUE;
+    config->search_exclude_tags = NULL;
+    config->search_exclude_tags_length = 0;
 
     if (! g_key_file_load_from_file (config->key_file,
                                     config->filename,
@@ -277,6 +320,7 @@ notmuch_config_open (void *ctx,
     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");
+    file_had_search_group = g_key_file_has_group (config->key_file, "search");
 
 
     if (notmuch_config_get_database_path (config) == NULL) {
@@ -327,8 +371,26 @@ notmuch_config_open (void *ctx,
        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);
+    if (notmuch_config_get_new_ignore (config, &tmp) == NULL) {
+       notmuch_config_set_new_ignore (config, NULL, 0);
+    }
+
+    if (notmuch_config_get_search_exclude_tags (config, &tmp) == NULL) {
+       if (is_new) {
+           const char *tags[] = { "deleted", "spam" };
+           notmuch_config_set_search_exclude_tags (config, tags, 2);
+       } else {
+           notmuch_config_set_search_exclude_tags (config, NULL, 0);
+       }
+    }
+
+    error = NULL;
+    config->maildir_synchronize_flags =
+       g_key_file_get_boolean (config->key_file,
+                               "maildir", "synchronize_flags", &error);
+    if (error) {
+       notmuch_config_set_maildir_synchronize_flags (config, TRUE);
+       g_error_free (error);
     }
 
     /* Whenever we know of configuration sections that don't appear in
@@ -364,6 +426,11 @@ notmuch_config_open (void *ctx,
                                maildir_config_comment, NULL);
     }
 
+    if (! file_had_search_group) {
+       g_key_file_set_comment (config->key_file, "search", NULL,
+                               search_config_comment, NULL);
+    }
+
     if (is_new_ret)
        *is_new_ret = is_new;
 
@@ -414,6 +481,48 @@ notmuch_config_save (notmuch_config_t *config)
     return 0;
 }
 
+static const char **
+_config_get_list (notmuch_config_t *config,
+                 const char *section, const char *key,
+                 const char ***outlist, size_t *list_length, size_t *ret_length)
+{
+    assert(outlist);
+
+    if (*outlist == NULL) {
+
+       char **inlist = g_key_file_get_string_list (config->key_file,
+                                            section, key, list_length, NULL);
+       if (inlist) {
+           unsigned int i;
+
+           *outlist = talloc_size (config, sizeof (char *) * (*list_length + 1));
+
+           for (i = 0; i < *list_length; i++)
+               (*outlist)[i] = talloc_strdup (*outlist, inlist[i]);
+
+           (*outlist)[i] = NULL;
+
+           g_strfreev (inlist);
+       }
+    }
+
+    if (ret_length)
+       *ret_length = *list_length;
+
+    return *outlist;
+}
+
+static void
+_config_set_list (notmuch_config_t *config,
+                 const char *group, const char *name,
+                 const char *list[],
+                 size_t length, const char ***config_var )
+{
+    g_key_file_set_string_list (config->key_file, group, name, list, length);
+    talloc_free (*config_var);
+    *config_var = NULL;
+}
+
 const char *
 notmuch_config_get_database_path (notmuch_config_t *config)
 {
@@ -499,91 +608,71 @@ notmuch_config_set_user_primary_email (notmuch_config_t *config,
 }
 
 const char **
-notmuch_config_get_user_other_email (notmuch_config_t *config,
-                                    size_t *length)
+notmuch_config_get_user_other_email (notmuch_config_t *config,   size_t *length)
 {
-    char **emails;
-    size_t emails_length;
-    unsigned int i;
-
-    if (config->user_other_email == NULL) {
-       emails = g_key_file_get_string_list (config->key_file,
-                                            "user", "other_email",
-                                            &emails_length, NULL);
-       if (emails) {
-           config->user_other_email = talloc_size (config,
-                                                   sizeof (char *) *
-                                                   (emails_length + 1));
-           for (i = 0; i < emails_length; i++)
-               config->user_other_email[i] = talloc_strdup (config->user_other_email,
-                                                            emails[i]);
-           config->user_other_email[i] = NULL;
-
-           g_strfreev (emails);
-
-           config->user_other_email_length = emails_length;
-       }
-    }
+    return _config_get_list (config, "user", "other_email",
+                            &(config->user_other_email),
+                            &(config->user_other_email_length), length);
+}
 
-    *length = config->user_other_email_length;
-    return config->user_other_email;
+const char **
+notmuch_config_get_new_tags (notmuch_config_t *config,   size_t *length)
+{
+    return _config_get_list (config, "new", "tags",
+                            &(config->new_tags),
+                            &(config->new_tags_length), length);
+}
+
+const char **
+notmuch_config_get_new_ignore (notmuch_config_t *config, size_t *length)
+{
+    return _config_get_list (config, "new", "ignore",
+                            &(config->new_ignore),
+                            &(config->new_ignore_length), length);
 }
 
 void
 notmuch_config_set_user_other_email (notmuch_config_t *config,
-                                    const char *other_email[],
+                                    const char *list[],
                                     size_t length)
 {
-    g_key_file_set_string_list (config->key_file,
-                               "user", "other_email",
-                               other_email, length);
+    _config_set_list (config, "user", "other_email", list, length,
+                    &(config->user_other_email));
+}
 
-    talloc_free (config->user_other_email);
-    config->user_other_email = NULL;
+void
+notmuch_config_set_new_tags (notmuch_config_t *config,
+                                    const char *list[],
+                                    size_t length)
+{
+    _config_set_list (config, "new", "tags", list, length,
+                    &(config->new_tags));
 }
 
-const char **
-notmuch_config_get_new_tags (notmuch_config_t *config,
-                            size_t *length)
+void
+notmuch_config_set_new_ignore (notmuch_config_t *config,
+                              const char *list[],
+                              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;
-       }
-    }
+    _config_set_list (config, "new", "ignore", list, length,
+                    &(config->new_ignore));
+}
 
-    *length = config->new_tags_length;
-    return config->new_tags;
+const char **
+notmuch_config_get_search_exclude_tags (notmuch_config_t *config, size_t *length)
+{
+    return _config_get_list (config, "search", "exclude_tags",
+                            &(config->search_exclude_tags),
+                            &(config->search_exclude_tags_length), length);
 }
 
 void
-notmuch_config_set_new_tags (notmuch_config_t *config,
-                            const char *new_tags[],
-                            size_t length)
+notmuch_config_set_search_exclude_tags (notmuch_config_t *config,
+                                     const char *list[],
+                                     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;
+    _config_set_list (config, "search", "exclude_tags", list, length,
+                     &(config->search_exclude_tags));
 }
 
 /* Given a configuration item of the form <group>.<key> return the
@@ -662,7 +751,7 @@ notmuch_config_command_get (void *ctx, char *item)
        for (i = 0; i < length; i++)
            printf ("%s\n", value[i]);
 
-       free (value);
+       g_strfreev (value);
     }
 
     notmuch_config_close (config);
@@ -710,18 +799,78 @@ notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[])
     return ret;
 }
 
+static int
+notmuch_config_command_list (void *ctx)
+{
+    notmuch_config_t *config;
+    char **groups;
+    size_t g, groups_length;
+
+    config = notmuch_config_open (ctx, NULL, NULL);
+    if (config == NULL)
+       return 1;
+
+    groups = g_key_file_get_groups (config->key_file, &groups_length);
+    if (groups == NULL)
+       return 1;
+
+    for (g = 0; g < groups_length; g++) {
+       char **keys;
+       size_t k, keys_length;
+
+       keys = g_key_file_get_keys (config->key_file,
+                                   groups[g], &keys_length, NULL);
+       if (keys == NULL)
+           continue;
+
+       for (k = 0; k < keys_length; k++) {
+           char *value;
+
+           value = g_key_file_get_string (config->key_file,
+                                          groups[g], keys[k], NULL);
+           if (value != NULL) {
+               printf ("%s.%s=%s\n", groups[g], keys[k], value);
+               free (value);
+           }
+       }
+
+       g_strfreev (keys);
+    }
+
+    g_strfreev (groups);
+
+    notmuch_config_close (config);
+
+    return 0;
+}
+
 int
 notmuch_config_command (void *ctx, int argc, char *argv[])
 {
-    if (argc < 2) {
-       fprintf (stderr, "Error: notmuch config requires at least two arguments.\n");
+    argc--; argv++; /* skip subcommand argument */
+
+    if (argc < 1) {
+       fprintf (stderr, "Error: notmuch config requires at least one argument.\n");
        return 1;
     }
 
-    if (strcmp (argv[0], "get") == 0)
+    if (strcmp (argv[0], "get") == 0) {
+       if (argc != 2) {
+           fprintf (stderr, "Error: notmuch config get requires exactly "
+                    "one argument.\n");
+           return 1;
+       }
        return notmuch_config_command_get (ctx, argv[1]);
-    else if (strcmp (argv[0], "set") == 0)
+    } else if (strcmp (argv[0], "set") == 0) {
+       if (argc < 2) {
+           fprintf (stderr, "Error: notmuch config set requires at least "
+                    "one argument.\n");
+           return 1;
+       }
        return notmuch_config_command_set (ctx, argv[1], argc - 2, argv + 2);
+    } else if (strcmp (argv[0], "list") == 0) {
+       return notmuch_config_command_list (ctx);
+    }
 
     fprintf (stderr, "Unrecognized argument for notmuch config: %s\n",
             argv[0]);
@@ -729,26 +878,16 @@ notmuch_config_command (void *ctx, int argc, char *argv[])
 }
 
 notmuch_bool_t
-notmuch_config_get_maildir_sync (notmuch_config_t *config)
+notmuch_config_get_maildir_synchronize_flags (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;
+    return config->maildir_synchronize_flags;
 }
 
 void
-notmuch_config_set_maildir_sync (notmuch_config_t *config,
-                                notmuch_bool_t maildir_sync)
+notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
+                                             notmuch_bool_t synchronize_flags)
 {
     g_key_file_set_boolean (config->key_file,
-                           "maildir", "synchronize_flags", maildir_sync);
-    config->maildir_sync = maildir_sync;
+                           "maildir", "synchronize_flags", synchronize_flags);
+    config->maildir_synchronize_flags = synchronize_flags;
 }