X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=lib%2Fmessage.cc;h=c2a9ebdf0e0b4d683d5afc826639011e3d21ddbf;hp=958ec734c838e19d5967be04c12fa45b478bc0af;hb=d9d3d3e6f06a76dc0fbe24c9655b64acfcd4b9e4;hpb=361b9d4bd9042629e3729b43d18a862ddc716242 diff --git a/lib/message.cc b/lib/message.cc index 958ec734..c2a9ebdf 100644 --- a/lib/message.cc +++ b/lib/message.cc @@ -25,8 +25,6 @@ #include -#include - struct _notmuch_message { notmuch_database_t *notmuch; Xapian::docid doc_id; @@ -43,6 +41,24 @@ struct _notmuch_message { Xapian::Document doc; }; +#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) + +struct maildir_flag_tag { + char flag; + const char *tag; + bool inverse; +}; + +/* ASCII ordered table of Maildir flags and associated tags */ +struct maildir_flag_tag flag2tag[] = { + { 'D', "draft", false}, + { 'F', "flagged", false}, + { 'P', "passed", false}, + { 'R', "replied", false}, + { 'S', "unread", true }, + { 'T', "deleted", false}, +}; + /* We end up having to call the destructor explicitly because we had * to use "placement new" in order to initialize C++ objects within a * block that we allocated with talloc. So C++ is making talloc @@ -57,35 +73,12 @@ _notmuch_message_destructor (notmuch_message_t *message) return 0; } -/* Create a new notmuch_message_t object for an existing document in - * the database. - * - * Here, 'talloc owner' is an optional talloc context to which the new - * message will belong. This allows for the caller to not bother - * calling notmuch_message_destroy on the message, and no that all - * memory will be reclaimed with 'talloc_owner' is free. The caller - * still can call notmuch_message_destroy when finished with the - * message if desired. - * - * The 'talloc_owner' argument can also be NULL, in which case the - * caller *is* responsible for calling notmuch_message_destroy. - * - * If no document exists in the database with document ID of 'doc_id' - * then this function returns NULL and optionally sets *status to - * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND. - * - * This function can also fail to due lack of available memory, - * returning NULL and optionally setting *status to - * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY. - * - * The caller can pass NULL for status if uninterested in - * distinguishing these two cases. - */ -notmuch_message_t * -_notmuch_message_create (const void *talloc_owner, - notmuch_database_t *notmuch, - unsigned int doc_id, - notmuch_private_status_t *status) +static notmuch_message_t * +_notmuch_message_create_for_document (const void *talloc_owner, + notmuch_database_t *notmuch, + unsigned int doc_id, + Xapian::Document doc, + notmuch_private_status_t *status) { notmuch_message_t *message; @@ -130,16 +123,53 @@ _notmuch_message_create (const void *talloc_owner, talloc_set_destructor (message, _notmuch_message_destructor); + message->doc = doc; + + return message; +} + +/* Create a new notmuch_message_t object for an existing document in + * the database. + * + * Here, 'talloc owner' is an optional talloc context to which the new + * message will belong. This allows for the caller to not bother + * calling notmuch_message_destroy on the message, and no that all + * memory will be reclaimed with 'talloc_owner' is free. The caller + * still can call notmuch_message_destroy when finished with the + * message if desired. + * + * The 'talloc_owner' argument can also be NULL, in which case the + * caller *is* responsible for calling notmuch_message_destroy. + * + * If no document exists in the database with document ID of 'doc_id' + * then this function returns NULL and optionally sets *status to + * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND. + * + * This function can also fail to due lack of available memory, + * returning NULL and optionally setting *status to + * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY. + * + * The caller can pass NULL for status if uninterested in + * distinguishing these two cases. + */ +notmuch_message_t * +_notmuch_message_create (const void *talloc_owner, + notmuch_database_t *notmuch, + unsigned int doc_id, + notmuch_private_status_t *status) +{ + Xapian::Document doc; + try { - message->doc = notmuch->xapian_db->get_document (doc_id); + doc = notmuch->xapian_db->get_document (doc_id); } catch (const Xapian::DocNotFoundError &error) { - talloc_free (message); if (status) *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND; return NULL; } - return message; + return _notmuch_message_create_for_document (talloc_owner, notmuch, + doc_id, doc, status); } /* Create a new notmuch_message_t object for a specific message ID, @@ -148,11 +178,24 @@ _notmuch_message_create (const void *talloc_owner, * The 'notmuch' database will be the talloc owner of the returned * message. * - * If there is already a document with message ID 'message_id' in the - * database, then the returned message can be used to query/modify the - * document. Otherwise, a new document will be inserted into the - * database before this function returns, (and *status will be set - * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND). + * This function returns a valid notmuch_message_t whether or not + * there is already a document in the database with the given message + * ID. These two cases can be distinguished by the value of *status: + * + * + * NOTMUCH_PRIVATE_STATUS_SUCCESS: + * + * There is already a document with message ID 'message_id' in the + * database. The returned message can be used to query/modify the + * document. + * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND: + * + * No document with 'message_id' exists in the database. The + * returned message contains a newly created document (not yet + * added to the database) and a document ID that is known not to + * exist in the database. The caller can modify the message, and a + * call to _notmuch_message_sync will add * the document to the + * database. * * If an error occurs, this function will return NULL and *status * will be set as appropriate. (The status pointer argument must @@ -192,7 +235,7 @@ _notmuch_message_create_for_message_id (notmuch_database_t *notmuch, doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id); - doc_id = db->add_document (doc); + doc_id = _notmuch_database_generate_doc_id (notmuch); } catch (const Xapian::Error &error) { fprintf (stderr, "A Xapian exception occurred creating message: %s\n", error.get_msg().c_str()); @@ -201,8 +244,8 @@ _notmuch_message_create_for_message_id (notmuch_database_t *notmuch, return NULL; } - message = _notmuch_message_create (notmuch, notmuch, - doc_id, status_ret); + message = _notmuch_message_create_for_document (notmuch, notmuch, + doc_id, doc, status_ret); /* We want to inform the caller that we had to create a new * document. */ @@ -568,15 +611,29 @@ _notmuch_message_set_date (notmuch_message_t *message, Xapian::sortable_serialise (time_value)); } +static notmuch_private_status_t +_notmuch_message_tags_to_maildir (notmuch_message_t *message); + /* Synchronize changes made to message->doc out into the database. */ void _notmuch_message_sync (notmuch_message_t *message) { Xapian::WritableDatabase *db; + notmuch_private_status_t status; if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) return; + if (message->notmuch->maildir_sync && + !notmuch_message_get_flag(message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID)) { + status = _notmuch_message_tags_to_maildir (message); + if (status != NOTMUCH_PRIVATE_STATUS_SUCCESS) { + fprintf (stderr, "Error: Cannot sync tags to maildir (%s)\n", + notmuch_status_to_string ((notmuch_status_t)status)); + /* Exit to avoid unsynchronized mailstore. */ + exit(1); + } + } db = static_cast (message->notmuch->xapian_db); db->replace_document (message->doc_id, message->doc); } @@ -688,6 +745,44 @@ _notmuch_message_remove_term (notmuch_message_t *message, return NOTMUCH_PRIVATE_STATUS_SUCCESS; } +/* Change the message filename stored in the database. + * + * This change will not be reflected in the database until the next + * call to _notmuch_message_sync. + */ +notmuch_private_status_t +_notmuch_message_rename (notmuch_message_t *message, + const char *new_filename) +{ + void *local = talloc_new (message); + char *direntry; + Xapian::PostingIterator i, end; + Xapian::Document document; + notmuch_private_status_t pstatus; + notmuch_status_t status; + const char *old_filename; + + old_filename = notmuch_message_get_filename(message); + old_filename = talloc_reference(local, old_filename); + if (unlikely(!old_filename)) + return NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY; + + status = _notmuch_message_add_filename (message, new_filename); + if (status) + return (notmuch_private_status_t)status; + + status = _notmuch_database_filename_to_direntry (local, message->notmuch, + old_filename, &direntry); + if (status) + return (notmuch_private_status_t)status; + + pstatus = _notmuch_message_remove_term (message, "file-direntry", direntry); + + talloc_free (local); + + return pstatus; +} + notmuch_status_t notmuch_message_add_tag (notmuch_message_t *message, const char *tag) { @@ -744,6 +839,162 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag) return NOTMUCH_STATUS_SUCCESS; } +notmuch_status_t +notmuch_message_maildir_to_tags (notmuch_message_t *message, const char *filename) +{ + const char *flags, *p; + char f; + bool valid, unread; + unsigned i; + notmuch_status_t status; + + flags = strstr (filename, ":2,"); + if (!flags) + return NOTMUCH_STATUS_FILE_NOT_EMAIL; + flags += 3; + + /* Check that the letters are valid Maildir flags */ + f = 0; + valid = true; + for (p=flags; valid && *p; p++) { + switch (*p) { + case 'P': + case 'R': + case 'S': + case 'T': + case 'D': + case 'F': + if (*p > f) f=*p; + else valid = false; + break; + default: + valid = false; + } + } + if (!valid) { + fprintf (stderr, "Warning: Invalid maildir flags in filename %s\n", filename); + return NOTMUCH_STATUS_FILE_NOT_EMAIL; + } + + status = notmuch_message_freeze (message); + if (status) + return status; + unread = true; + for (i = 0; i < ARRAY_SIZE(flag2tag); i++) { + if ((strchr (flags, flag2tag[i].flag) != NULL) ^ flag2tag[i].inverse) { + status = notmuch_message_add_tag (message, flag2tag[i].tag); + } else { + status = notmuch_message_remove_tag (message, flag2tag[i].tag); + } + if (status) + return status; + } + status = notmuch_message_thaw (message); + + /* From now on, we can synchronize the tags from the database to + * the mailstore. */ + notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID, FALSE); + return status; +} + +static void +maildir_get_new_flags(notmuch_message_t *message, char *flags) +{ + notmuch_tags_t *tags; + const char *tag; + unsigned i; + char *p; + + for (i = 0; i < ARRAY_SIZE(flag2tag); i++) + flags[i] = flag2tag[i].inverse ? flag2tag[i].flag : '\0'; + + for (tags = notmuch_message_get_tags (message); + notmuch_tags_valid (tags); + notmuch_tags_move_to_next (tags)) + { + tag = notmuch_tags_get (tags); + for (i = 0; i < ARRAY_SIZE(flag2tag); i++) { + if (strcmp(tag, flag2tag[i].tag) == 0) + flags[i] = flag2tag[i].inverse ? '\0' : flag2tag[i].flag; + } + } + + p = flags; + for (i = 0; i < ARRAY_SIZE(flag2tag); i++) { + if (flags[i]) + *p++ = flags[i]; + } + *p = '\0'; +} + +static char * +maildir_get_subdir (char *filename) +{ + char *p, *subdir = NULL; + + p = filename + strlen (filename) - 1; + while (p > filename + 3 && *p != '/') + p--; + if (*p == '/') { + subdir = p - 3; + if (subdir > filename && *(subdir - 1) != '/') + subdir = NULL; + } + return subdir; +} + +/* Rename the message file so that maildir flags corresponds to the + * tags and, if aplicable, move the message from new/ to cur/. */ +static notmuch_private_status_t +_notmuch_message_tags_to_maildir (notmuch_message_t *message) +{ + char flags[ARRAY_SIZE(flag2tag)+1]; + const char *filename, *p; + char *filename_new, *subdir = NULL; + int ret; + + maildir_get_new_flags (message, flags); + + filename = notmuch_message_get_filename (message); + /* TODO: Iterate over all file names. */ + p = strstr(filename, ":2,"); + if ((p && strcmp (p+3, flags) == 0) || + (!p && flags[0] == '\0')) { + // Return if flags are not to be changed - this suppresses + // moving the message from new/ to cur/ during initial + // tagging. + return NOTMUCH_PRIVATE_STATUS_SUCCESS; + } + if (!p) + p = filename + strlen(filename); + + filename_new = (char*)talloc_size(message, (p-filename) + 3 + sizeof(flags)); + if (unlikely (filename_new == NULL)) + return NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY; + memcpy(filename_new, filename, p-filename); + filename_new[p-filename] = '\0'; + + /* If message is in new/ move it under cur/. */ + subdir = maildir_get_subdir (filename_new); + if (subdir && memcmp (subdir, "new/", 4) == 0) + memcpy (subdir, "cur/", 4); + + strcpy (filename_new+(p-filename), ":2,"); + strcpy (filename_new+(p-filename)+3, flags); + + if (strcmp (filename, filename_new) != 0) { + ret = rename (filename, filename_new); + if (ret == -1) { + perror (talloc_asprintf (message, "rename of %s to %s failed", + filename, filename_new)); + exit (1); + } + return _notmuch_message_rename (message, filename_new); + /* _notmuch_message_sync is our caller. Do not call it here. */ + } + return NOTMUCH_PRIVATE_STATUS_SUCCESS; +} + notmuch_status_t notmuch_message_remove_all_tags (notmuch_message_t *message) {