#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"
" 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"
" 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"
+ " 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"
+ "\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;
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_synchronize_flags;
+ const char **search_exclude_tags;
+ size_t search_exclude_tags_length;
};
static int
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) {
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;
* 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.
*
- * The default configuration settings are determined as follows:
+ * 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.
+ *
+ * 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,
{
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;
+ int file_had_search_group;
if (is_new_ret)
*is_new_ret = 0;
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_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))
{
- /* We are capable of dealing with a non-existent configuration
- * file, so be silent about that (unless the user had set a
- * non-default configuration file with the NOTMUCH_CONFIG
- * variable)
+ /* 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 (notmuch_config_env ||
- !(error->domain == G_FILE_ERROR &&
- error->code == G_FILE_ERROR_NOENT))
+ 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);
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");
+ 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) {
char *path = talloc_asprintf (config, "%s/mail",
getenv ("HOME"));
}
}
- /* 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_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
+ * 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 (! 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;
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)
{
config->user_primary_email = NULL;
}
-char **
-notmuch_config_get_user_other_email (notmuch_config_t *config,
- size_t *length)
+const char **
+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);
}
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_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_search_exclude_tags (notmuch_config_t *config,
+ const char *list[],
+ size_t length)
+{
+ _config_set_list (config, "search", "exclude_tags", list, length,
+ &(config->search_exclude_tags));
+}
+
+/* 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[])
+{
+ argc--; argv++; /* skip subcommand argument */
+
+ 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_synchronize_flags (notmuch_config_t *config)
+{
+ return config->maildir_synchronize_flags;
+}
+
+void
+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", synchronize_flags);
+ config->maildir_synchronize_flags = synchronize_flags;
}
projects / notmuch / blobdiff