X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-config.c;h=48312e3f913dda58151efbe591415f875751bb05;hp=6e4c5c4c0c93738f643b4048152c0d2de826a5f4;hb=4ef2106792439f5ade157b3ba3b8f7fa86fcb3ed;hpb=3185df17eb6c7621df3945841af58f2b19facc40 diff --git a/notmuch-config.c b/notmuch-config.c index 6e4c5c4c..48312e3f 100644 --- a/notmuch-config.c +++ b/notmuch-config.c @@ -22,6 +22,7 @@ #include #include +#include static const char toplevel_config_comment[] = " .notmuch-config - Configuration file for the notmuch mail system\n" @@ -43,7 +44,14 @@ 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\n" + "\t names will be ignored, independent of its depth/location\n" + "\t in the mail store.\n"; static const char user_config_comment[] = " User configuration\n" @@ -69,7 +77,7 @@ static const char maildir_config_comment[] = "\tsynchronize_flags Valid values are true and false.\n" "\n" "\tIf true, then the following maildir flags (in message filenames)\n" - "\twill be syncrhonized with the corresponding notmuch tags:\n" + "\twill be synchronized with the corresponding notmuch tags:\n" "\n" "\t\tFlag Tag\n" "\t\t---- -------\n" @@ -83,9 +91,20 @@ static const char maildir_config_comment[] = "\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" + "\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; GKeyFile *key_file; + notmuch_bool_t is_new; char *database_path; char *user_name; @@ -94,7 +113,11 @@ struct _notmuch_config { size_t user_other_email_length; const char **new_tags; size_t new_tags_length; + 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; }; static int @@ -210,19 +233,16 @@ get_username_from_passwd_file (void *ctx) notmuch_config_t * notmuch_config_open (void *ctx, const char *filename, - notmuch_bool_t *is_new_ret) + notmuch_bool_t create_new) { 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; + int file_had_search_group; notmuch_config_t *config = talloc (ctx, notmuch_config_t); if (config == NULL) { @@ -243,6 +263,7 @@ notmuch_config_open (void *ctx, config->key_file = g_key_file_new (); + config->is_new = FALSE; config->database_path = NULL; config->user_name = NULL; config->user_primary_email = NULL; @@ -250,24 +271,27 @@ notmuch_config_open (void *ctx, config->user_other_email_length = 0; config->new_tags = NULL; config->new_tags_length = 0; + 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, G_KEY_FILE_KEEP_COMMENTS, &error)) { - /* 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 create_new is true, 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 && + if (create_new && error->domain == G_FILE_ERROR && error->code == G_FILE_ERROR_NOENT) { g_error_free (error); - is_new = 1; + config->is_new = TRUE; } else { @@ -294,6 +318,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) { @@ -344,6 +369,19 @@ notmuch_config_open (void *ctx, notmuch_config_set_new_tags (config, tags, 2); } + 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 (config->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, @@ -356,7 +394,7 @@ notmuch_config_open (void *ctx, /* 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) + if (config->is_new) { g_key_file_set_comment (config->key_file, NULL, NULL, toplevel_config_comment, NULL); @@ -386,8 +424,10 @@ notmuch_config_open (void *ctx, maildir_config_comment, NULL); } - if (is_new_ret) - *is_new_ret = is_new; + if (! file_had_search_group) { + g_key_file_set_comment (config->key_file, "search", NULL, + search_config_comment, NULL); + } return config; } @@ -436,6 +476,55 @@ notmuch_config_save (notmuch_config_t *config) return 0; } +notmuch_bool_t +notmuch_config_is_new (notmuch_config_t *config) +{ + return config->is_new; +} + + +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) { @@ -521,91 +610,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 . return the @@ -636,14 +705,8 @@ _item_split (char *item, char **group, char **key) } static int -notmuch_config_command_get (void *ctx, char *item) +notmuch_config_command_get (notmuch_config_t *config, 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) { @@ -684,28 +747,20 @@ 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); - return 0; } static int -notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[]) +notmuch_config_command_set (notmuch_config_t *config, 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. * @@ -726,24 +781,74 @@ notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[]) break; } - ret = notmuch_config_save (config); - notmuch_config_close (config); + return notmuch_config_save (config); +} + +static int +notmuch_config_command_list (notmuch_config_t *config) +{ + char **groups; + size_t g, groups_length; + + 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); + } + } - return ret; + g_strfreev (keys); + } + + g_strfreev (groups); + + return 0; } int -notmuch_config_command (void *ctx, int argc, char *argv[]) +notmuch_config_command (notmuch_config_t *config, 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) - 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); + 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 (config, argv[1]); + } 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 (config, argv[1], argc - 2, argv + 2); + } else if (strcmp (argv[0], "list") == 0) { + return notmuch_config_command_list (config); + } fprintf (stderr, "Unrecognized argument for notmuch config: %s\n", argv[0]);