[PATCH 3/4] Make maildir synchronization configurable
Michal Sojka
sojkam1 at fel.cvut.cz
Wed Oct 13 05:13:57 PDT 2010
This adds group [maildir] and key 'sync_level' to the configuration file.
The value of sync_level is used to control how the synchronization happens.
The default value is no synchronization.
---
lib/database-private.h | 2 +-
lib/database.cc | 9 +++++++++
lib/message.cc | 2 +-
lib/notmuch.h | 19 +++++++++++++++++++
notmuch-client.h | 7 +++++++
notmuch-config.c | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
notmuch-new.c | 8 ++++++--
notmuch-restore.c | 2 ++
notmuch-setup.c | 17 +++++++++++++++++
notmuch-tag.c | 2 ++
10 files changed, 112 insertions(+), 4 deletions(-)
diff --git a/lib/database-private.h b/lib/database-private.h
index bd72f67..3c80f99 100644
--- a/lib/database-private.h
+++ b/lib/database-private.h
@@ -49,7 +49,7 @@ struct _notmuch_database {
Xapian::QueryParser *query_parser;
Xapian::TermGenerator *term_gen;
Xapian::ValueRangeProcessor *value_range_processor;
-
+ enum notmuch_maildir_sync maildir_sync;
};
/* Convert tags from Xapian internal format to notmuch format.
diff --git a/lib/database.cc b/lib/database.cc
index 9652013..d6b6f47 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -689,6 +689,8 @@ notmuch_database_open (const char *path,
notmuch = NULL;
}
+ notmuch_database_set_maildir_sync (notmuch, NOTMUCH_MAILDIR_SYNC_NONE);
+
DONE:
if (notmuch_path)
free (notmuch_path);
@@ -718,6 +720,13 @@ notmuch_database_close (notmuch_database_t *notmuch)
talloc_free (notmuch);
}
+void
+notmuch_database_set_maildir_sync (notmuch_database_t *database,
+ enum notmuch_maildir_sync maildir_sync)
+{
+ database->maildir_sync = maildir_sync;
+}
+
const char *
notmuch_database_get_path (notmuch_database_t *notmuch)
{
diff --git a/lib/message.cc b/lib/message.cc
index 96c402c..1b945c6 100644
--- a/lib/message.cc
+++ b/lib/message.cc
@@ -626,7 +626,7 @@ _notmuch_message_sync (notmuch_message_t *message)
if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
return;
- if (// todo_sync_enabled &&
+ if (message->notmuch->maildir_sync == NOTMUCH_MAILDIR_SYNC_NEW_RENAMED_TAGGED &&
!notmuch_message_get_flag(message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID)) {
status = _notmuch_message_tags_to_maildir (message);
if (status != NOTMUCH_PRIVATE_STATUS_SUCCESS) {
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 408d633..34b3bcf 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -108,6 +108,19 @@ typedef enum _notmuch_status {
const char *
notmuch_status_to_string (notmuch_status_t status);
+/* Level of synchronization between notmuch tags and maildir flags. */
+enum notmuch_maildir_sync {
+ NOTMUCH_MAILDIR_SYNC_INVALID = 0,
+ /* No synchronization */
+ NOTMUCH_MAILDIR_SYNC_NONE,
+ /* Tag new messages accoring to maildir flags */
+ NOTMUCH_MAILDIR_SYNC_NEW,
+ /* The above + update tags for renamed messages */
+ NOTMUCH_MAILDIR_SYNC_NEW_RENAMED,
+ /* The above + update flags when tags are added/removed. */
+ NOTMUCH_MAILDIR_SYNC_NEW_RENAMED_TAGGED,
+};
+
/* Various opaque data types. For each notmuch_<foo>_t see the various
* notmuch_<foo> functions below. */
typedef struct _notmuch_database notmuch_database_t;
@@ -176,6 +189,12 @@ notmuch_database_open (const char *path,
void
notmuch_database_close (notmuch_database_t *database);
+/* Sets the level of synchronization between maildir flags and notmuch
+ * tags. */
+void
+notmuch_database_set_maildir_sync (notmuch_database_t *database,
+ enum notmuch_maildir_sync maildir_sync);
+
/* Return the database path of the given database.
*
* The return value is a string owned by notmuch so should not be
diff --git a/notmuch-client.h b/notmuch-client.h
index 20be43b..50be95c 100644
--- a/notmuch-client.h
+++ b/notmuch-client.h
@@ -191,6 +191,13 @@ notmuch_config_set_new_tags (notmuch_config_t *config,
const char *new_tags[],
size_t length);
+enum notmuch_maildir_sync
+notmuch_config_get_maildir_sync (notmuch_config_t *config);
+
+void
+notmuch_config_set_maildir_sync (notmuch_config_t *config,
+ enum notmuch_maildir_sync maildir_sync);
+
notmuch_bool_t
debugger_is_active (void);
diff --git a/notmuch-config.c b/notmuch-config.c
index cf30603..60d5730 100644
--- a/notmuch-config.c
+++ b/notmuch-config.c
@@ -61,6 +61,21 @@ static const char user_config_comment[] =
" 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"
+ " Here you can configure whether and how will notmuch synchronize its\n"
+ " tags with maildir flags."
+ "\n"
+ "\tsync_level Integer in the range 1 - 4 with the following meaning:\n"
+ "\t\t1 - No synchronization at all.\n"
+ "\t\t2 - 'notmuch new' tags the messages based on their maildir flags\n"
+ "\t\t only when it sees them for the first time.\n"
+ "\t\t3 - Same as 2 plus 'notmuch new' updates tags when it detects the\n"
+ "\t\t message was renamed.\n"
+ "\t\t4 - Same as 3 plus whenever message tags are changed, maildir\n"
+ "\t\t flags are updated accordingly.\n";
+
struct _notmuch_config {
char *filename;
GKeyFile *key_file;
@@ -72,6 +87,7 @@ struct _notmuch_config {
size_t user_other_email_length;
const char **new_tags;
size_t new_tags_length;
+ enum notmuch_maildir_sync maildir_sync;
};
static int
@@ -191,6 +207,7 @@ notmuch_config_open (void *ctx,
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;
@@ -221,6 +238,7 @@ notmuch_config_open (void *ctx,
config->user_other_email_length = 0;
config->new_tags = NULL;
config->new_tags_length = 0;
+ config->maildir_sync = NOTMUCH_MAILDIR_SYNC_INVALID;
if (! g_key_file_load_from_file (config->key_file,
config->filename,
@@ -263,6 +281,7 @@ notmuch_config_open (void *ctx,
"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");
if (notmuch_config_get_database_path (config) == NULL) {
@@ -313,6 +332,10 @@ notmuch_config_open (void *ctx,
notmuch_config_set_new_tags (config, tags, 2);
}
+ if (notmuch_config_get_maildir_sync (config) == NOTMUCH_MAILDIR_SYNC_INVALID) {
+ notmuch_config_set_maildir_sync (config, NOTMUCH_MAILDIR_SYNC_NONE);
+ }
+
/* 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. */
@@ -340,6 +363,12 @@ notmuch_config_open (void *ctx,
user_config_comment, NULL);
}
+ if (! file_had_maildir_group)
+ {
+ g_key_file_set_comment (config->key_file, "maildir", NULL,
+ maildir_config_comment, NULL);
+ }
+
if (is_new_ret)
*is_new_ret = is_new;
@@ -562,3 +591,22 @@ notmuch_config_set_new_tags (notmuch_config_t *config,
config->new_tags = NULL;
}
+enum notmuch_maildir_sync
+notmuch_config_get_maildir_sync (notmuch_config_t *config)
+{
+ if (config->maildir_sync == NOTMUCH_MAILDIR_SYNC_INVALID) {
+ config->maildir_sync =
+ g_key_file_get_integer (config->key_file,
+ "maildir", "sync_level", NULL);
+ }
+ return config->maildir_sync;
+}
+
+void
+notmuch_config_set_maildir_sync (notmuch_config_t *config,
+ enum notmuch_maildir_sync maildir_sync)
+{
+ g_key_file_set_integer (config->key_file,
+ "maildir", "sync_level", maildir_sync);
+ config->maildir_sync = maildir_sync;
+}
diff --git a/notmuch-new.c b/notmuch-new.c
index ed3f944..40ea610 100644
--- a/notmuch-new.c
+++ b/notmuch-new.c
@@ -45,6 +45,7 @@ typedef struct {
_filename_list_t *removed_files;
_filename_list_t *removed_directories;
+ enum notmuch_maildir_sync maildir_sync;
} add_files_state_t;
static volatile sig_atomic_t do_add_files_print_progress = 0;
@@ -410,11 +411,13 @@ add_files_recursive (notmuch_database_t *notmuch,
state->added_messages++;
for (tag=state->new_tags; *tag != NULL; tag++)
notmuch_message_add_tag (message, *tag);
- notmuch_message_maildir_to_tags (message, next);
+ if (state->maildir_sync >= NOTMUCH_MAILDIR_SYNC_NEW)
+ notmuch_message_maildir_to_tags (message, next);
break;
/* Non-fatal issues (go on to next file) */
case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
- notmuch_message_maildir_to_tags (message, next);
+ if (state->maildir_sync >= NOTMUCH_MAILDIR_SYNC_NEW_RENAMED)
+ notmuch_message_maildir_to_tags (message, next);
break;
case NOTMUCH_STATUS_FILE_NOT_EMAIL:
fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
@@ -738,6 +741,7 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
return 1;
add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
+ add_files_state.maildir_sync = notmuch_config_get_maildir_sync (config);
db_path = notmuch_config_get_database_path (config);
dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
diff --git a/notmuch-restore.c b/notmuch-restore.c
index b0a4e1c..b5c5c48 100644
--- a/notmuch-restore.c
+++ b/notmuch-restore.c
@@ -41,6 +41,8 @@ notmuch_restore_command (unused (void *ctx), int argc, char *argv[])
if (notmuch == NULL)
return 1;
+ notmuch_database_set_maildir_sync (notmuch,
+ notmuch_config_get_maildir_sync (config));
if (argc) {
input = fopen (argv[0], "r");
if (input == NULL) {
diff --git a/notmuch-setup.c b/notmuch-setup.c
index 955deb7..8364854 100644
--- a/notmuch-setup.c
+++ b/notmuch-setup.c
@@ -195,6 +195,23 @@ notmuch_setup_command (unused (void *ctx),
g_ptr_array_free (tags, TRUE);
}
+ printf ("\n"
+ "Notmuch can synchronize certain tags with maildir flags. You can\n"
+ "select between several levels of synchronization:\n"
+ "1 - No synchronization at all.\n"
+ "2 - 'notmuch new' tags the messages based on their maildir flags\n"
+ " only when it sees them for the first time.\n"
+ "3 - Same as 2 plus 'notmuch new' updates tags when it detects the\n"
+ " message was renamed.\n"
+ "4 - Same as 3 plus whenever message tags are changed, maildir\n"
+ " flags are updated accordingly.\n");
+
+ prompt ("Maildir synchronization level [%d]: ", notmuch_config_get_maildir_sync (config));
+ if (strlen (response) == 1 &&
+ response[0] >= '1' &&
+ response[0] <= '4')
+ notmuch_config_set_maildir_sync (config, atoi (response));
+
if (! notmuch_config_save (config)) {
if (is_new)
welcome_message_post_setup ();
diff --git a/notmuch-tag.c b/notmuch-tag.c
index fd54bc7..3a489a9 100644
--- a/notmuch-tag.c
+++ b/notmuch-tag.c
@@ -100,6 +100,8 @@ notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[]))
NOTMUCH_DATABASE_MODE_READ_WRITE);
if (notmuch == NULL)
return 1;
+ notmuch_database_set_maildir_sync (notmuch,
+ notmuch_config_get_maildir_sync (config));
query = notmuch_query_create (notmuch, query_string);
if (query == NULL) {
--
1.7.1.3.g75e44
More information about the notmuch
mailing list