]> git.notmuchmail.org Git - notmuch/blobdiff - lib/message.cc
Fix notmuch_message_maildir_flags_to_tags to iterate over filenames
[notmuch] / lib / message.cc
index baeaa46972867d10a1cc5cde801fac03c0817df1..ee52672a6ca5e1c1d514a31bb63271ac03725baa 100644 (file)
@@ -25,8 +25,6 @@
 
 #include <gmime/gmime.h>
 
-#include <xapian.h>
-
 struct _notmuch_message {
     notmuch_database_t *notmuch;
     Xapian::docid doc_id;
@@ -34,7 +32,8 @@ struct _notmuch_message {
     char *message_id;
     char *thread_id;
     char *in_reply_to;
-    char *filename;
+    notmuch_filename_list_t *filename_list;
+    char *author;
     notmuch_message_file_t *message_file;
     notmuch_message_list_t *replies;
     unsigned long flags;
@@ -42,12 +41,22 @@ struct _notmuch_message {
     Xapian::Document doc;
 };
 
-/* "128 bits of thread-id ought to be enough for anybody" */
-#define NOTMUCH_THREAD_ID_BITS  128
-#define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
-typedef struct _thread_id {
-    char str[NOTMUCH_THREAD_ID_DIGITS + 1];
-} thread_id_t;
+#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 }
+};
 
 /* We end up having to call the destructor explicitly because we had
  * to use "placement new" in order to initialize C++ objects within a
@@ -63,35 +72,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;
 
@@ -115,8 +101,9 @@ _notmuch_message_create (const void *talloc_owner,
     message->message_id = NULL;
     message->thread_id = NULL;
     message->in_reply_to = NULL;
-    message->filename = NULL;
+    message->filename_list = NULL;
     message->message_file = NULL;
+    message->author = NULL;
 
     message->replies = _notmuch_message_list_create (message);
     if (unlikely (message->replies == NULL)) {
@@ -135,16 +122,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,
@@ -153,11 +177,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,12 +229,12 @@ _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 
     db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
     try {
-       doc.add_term (term);
+       doc.add_term (term, 0);
        talloc_free (term);
 
        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());
@@ -206,8 +243,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. */
@@ -386,7 +423,7 @@ notmuch_message_get_replies (notmuch_message_t *message)
 /* Add an additional 'filename' for 'message'.
  *
  * This change will not be reflected in the database until the next
- * call to _notmuch_message_set_sync. */
+ * call to _notmuch_message_sync. */
 notmuch_status_t
 _notmuch_message_add_filename (notmuch_message_t *message,
                               const char *filename)
@@ -395,9 +432,9 @@ _notmuch_message_add_filename (notmuch_message_t *message,
     void *local = talloc_new (message);
     char *direntry;
 
-    if (message->filename) {
-       talloc_free (message->filename);
-       message->filename = NULL;
+    if (message->filename_list) {
+       _notmuch_filename_list_destroy (message->filename_list);
+       message->filename_list = NULL;
     }
 
     if (filename == NULL)
@@ -416,46 +453,35 @@ _notmuch_message_add_filename (notmuch_message_t *message,
     return NOTMUCH_STATUS_SUCCESS;
 }
 
-/* Move the filename from the data field (as it was in database format
- * version 0) to a file-direntry term instead (as in database format
- * version 1).
- */
-void
-_notmuch_message_upgrade_filename_storage (notmuch_message_t *message)
+char *
+_notmuch_message_talloc_copy_data (notmuch_message_t *message)
 {
-    char *filename;
+    return talloc_strdup (message, message->doc.get_data ().c_str ());
+}
 
-    filename = talloc_strdup (message, message->doc.get_data ().c_str ());
-    if (filename && *filename != '\0') {
-       _notmuch_message_add_filename (message, filename);
-       message->doc.set_data ("");
-       _notmuch_message_sync (message);
-    }
-    talloc_free (filename);
+void
+_notmuch_message_clear_data (notmuch_message_t *message)
+{
+    message->doc.set_data ("");
 }
 
-const char *
-notmuch_message_get_filename (notmuch_message_t *message)
+static void
+_notmuch_message_ensure_filename_list (notmuch_message_t *message)
 {
     const char *prefix = _find_prefix ("file-direntry");
     int prefix_len = strlen (prefix);
     Xapian::TermIterator i;
-    char *direntry, *colon;
-    const char *db_path, *directory, *basename;
-    unsigned int directory_id;
-    void *local = talloc_new (message);
 
-    if (message->filename)
-       return message->filename;
+    if (message->filename_list)
+       return;
+
+    message->filename_list = _notmuch_filename_list_create (message);
 
     i = message->doc.termlist_begin ();
     i.skip_to (prefix);
 
-    if (i != message->doc.termlist_end ())
-       direntry = talloc_strdup (local, (*i).c_str ());
-
     if (i == message->doc.termlist_end () ||
-       strncmp (direntry, prefix, prefix_len))
+       strncmp ((*i).c_str (), prefix, prefix_len))
     {
        /* A message document created by an old version of notmuch
         * (prior to rename support) will have the filename in the
@@ -470,39 +496,77 @@ notmuch_message_get_filename (notmuch_message_t *message)
        if (data == NULL)
            INTERNAL_ERROR ("message with no filename");
 
-       message->filename = talloc_strdup (message, data);
+       _notmuch_filename_list_add_filename (message->filename_list, data);
 
-       return message->filename;
+       return;
     }
 
-    direntry += prefix_len;
+    for (; i != message->doc.termlist_end (); i++) {
+       void *local = talloc_new (message);
+       const char *db_path, *directory, *basename, *filename;
+       char *colon, *direntry = NULL;
+       unsigned int directory_id;
+
+       /* Terminate loop at first term without desired prefix. */
+       if (strncmp ((*i).c_str (), prefix, prefix_len))
+           break;
 
-    directory_id = strtol (direntry, &colon, 10);
+       direntry = talloc_strdup (local, (*i).c_str ());
 
-    if (colon == NULL || *colon != ':')
-       INTERNAL_ERROR ("malformed direntry");
+       direntry += prefix_len;
 
-    basename = colon + 1;
+       directory_id = strtol (direntry, &colon, 10);
 
-    *colon = '\0';
+       if (colon == NULL || *colon != ':')
+           INTERNAL_ERROR ("malformed direntry");
 
-    db_path = notmuch_database_get_path (message->notmuch);
+       basename = colon + 1;
 
-    directory = _notmuch_database_get_directory_path (local,
-                                                     message->notmuch,
-                                                     directory_id);
+       *colon = '\0';
 
-    if (strlen (directory))
-       message->filename = talloc_asprintf (message, "%s/%s/%s",
-                                            db_path, directory, basename);
-    else
-       message->filename = talloc_asprintf (message, "%s/%s",
-                                            db_path, basename);
-    talloc_free ((void *) directory);
+       db_path = notmuch_database_get_path (message->notmuch);
 
-    talloc_free (local);
+       directory = _notmuch_database_get_directory_path (local,
+                                                         message->notmuch,
+                                                         directory_id);
+
+       if (strlen (directory))
+           filename = talloc_asprintf (message, "%s/%s/%s",
+                                       db_path, directory, basename);
+       else
+           filename = talloc_asprintf (message, "%s/%s",
+                                       db_path, basename);
 
-    return message->filename;
+       _notmuch_filename_list_add_filename (message->filename_list,
+                                            filename);
+
+       talloc_free (local);
+    }
+}
+
+const char *
+notmuch_message_get_filename (notmuch_message_t *message)
+{
+    _notmuch_message_ensure_filename_list (message);
+
+    if (message->filename_list == NULL)
+       return NULL;
+
+    if (message->filename_list->head == NULL ||
+       message->filename_list->head->filename == NULL)
+    {
+       INTERNAL_ERROR ("message with no filename");
+    }
+
+    return message->filename_list->head->filename;
+}
+
+notmuch_filenames_t *
+notmuch_message_get_filenames (notmuch_message_t *message)
+{
+    _notmuch_message_ensure_filename_list (message);
+
+    return _notmuch_filenames_create (message, message->filename_list);
 }
 
 notmuch_bool_t
@@ -546,6 +610,22 @@ notmuch_message_get_tags (notmuch_message_t *message)
     return _notmuch_convert_tags(message, i, end);
 }
 
+const char *
+notmuch_message_get_author (notmuch_message_t *message)
+{
+    return message->author;
+}
+
+void
+notmuch_message_set_author (notmuch_message_t *message,
+                           const char *author)
+{
+    if (message->author)
+       talloc_free(message->author);
+    message->author = talloc_strdup(message, author);
+    return;
+}
+
 void
 _notmuch_message_set_date (notmuch_message_t *message,
                           const char *date)
@@ -563,45 +643,6 @@ _notmuch_message_set_date (notmuch_message_t *message,
                            Xapian::sortable_serialise (time_value));
 }
 
-static void
-thread_id_generate (thread_id_t *thread_id)
-{
-    static int seeded = 0;
-    FILE *dev_random;
-    uint32_t value;
-    char *s;
-    int i;
-
-    if (! seeded) {
-       dev_random = fopen ("/dev/random", "r");
-       if (dev_random == NULL) {
-           srand (time (NULL));
-       } else {
-           fread ((void *) &value, sizeof (value), 1, dev_random);
-           srand (value);
-           fclose (dev_random);
-       }
-       seeded = 1;
-    }
-
-    s = thread_id->str;
-    for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
-       value = rand ();
-       sprintf (s, "%08x", value);
-       s += 8;
-    }
-}
-
-void
-_notmuch_message_ensure_thread_id (notmuch_message_t *message)
-{
-    /* If not part of any existing thread, generate a new thread_id. */
-    thread_id_t thread_id;
-
-    thread_id_generate (&thread_id);
-    _notmuch_message_add_term (message, "thread", thread_id.str);
-}
-
 /* Synchronize changes made to message->doc out into the database. */
 void
 _notmuch_message_sync (notmuch_message_t *message)
@@ -634,7 +675,7 @@ _notmuch_message_close (notmuch_message_t *message)
  * names to prefix values.
  *
  * This change will not be reflected in the database until the next
- * call to _notmuch_message_set_sync. */
+ * call to _notmuch_message_sync. */
 notmuch_private_status_t
 _notmuch_message_add_term (notmuch_message_t *message,
                           const char *prefix_name,
@@ -652,7 +693,7 @@ _notmuch_message_add_term (notmuch_message_t *message,
     if (strlen (term) > NOTMUCH_TERM_MAX)
        return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 
-    message->doc.add_term (term);
+    message->doc.add_term (term, 0);
 
     talloc_free (term);
 
@@ -691,7 +732,7 @@ _notmuch_message_gen_terms (notmuch_message_t *message,
  * names to prefix values.
  *
  * This change will not be reflected in the database until the next
- * call to _notmuch_message_set_sync. */
+ * call to _notmuch_message_sync. */
 notmuch_private_status_t
 _notmuch_message_remove_term (notmuch_message_t *message,
                              const char *prefix_name,
@@ -722,6 +763,46 @@ _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_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 private_status;
+    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_STATUS_OUT_OF_MEMORY;
+
+    status = _notmuch_message_add_filename (message, new_filename);
+    if (status)
+       return status;
+
+    status = _notmuch_database_filename_to_direntry (local, message->notmuch,
+                                                    old_filename, &direntry);
+    if (status)
+       return status;
+
+    private_status = _notmuch_message_remove_term (message, "file-direntry", direntry);
+    status = COERCE_STATUS (private_status,
+                           "Unexpected error from _notmuch_message_remove_term");
+
+    talloc_free (local);
+
+    return status;
+}
+
 notmuch_status_t
 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 {
@@ -778,6 +859,157 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
     return NOTMUCH_STATUS_SUCCESS;
 }
 
+notmuch_status_t
+notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
+{
+    const char *flags;
+    notmuch_status_t status;
+    notmuch_filenames_t *filenames;
+    const char *filename;
+    char *combined_flags = talloc_strdup (message, "");
+    unsigned i;
+
+    for (filenames = notmuch_message_get_filenames (message);
+        notmuch_filenames_valid (filenames);
+        notmuch_filenames_move_to_next (filenames))
+    {
+       filename = notmuch_filenames_get (filenames);
+
+       flags = strstr (filename, ":2,");
+       if (! flags)
+           continue;
+
+       flags += 3;
+
+       combined_flags = talloc_strdup_append (combined_flags, flags);
+    }
+
+    status = notmuch_message_freeze (message);
+    if (status)
+       return status;
+
+    for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
+       if ((strchr (combined_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);
+
+    talloc_free (combined_flags);
+
+    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;
+}
+
+/* XXX: Needs to iterate over all filenames in the message
+ *
+ * XXX: Needs to ensure that existing, unsupported flags in the
+ *      filename are left unchanged (which also needs a test in the
+ *      test suite).
+ */
+notmuch_status_t
+notmuch_message_tags_to_maildir_flags (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_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_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_STATUS_SUCCESS;
+}
+
 notmuch_status_t
 notmuch_message_remove_all_tags (notmuch_message_t *message)
 {
@@ -791,8 +1023,8 @@ notmuch_message_remove_all_tags (notmuch_message_t *message)
        return status;
 
     for (tags = notmuch_message_get_tags (message);
-        notmuch_tags_has_more (tags);
-        notmuch_tags_advance (tags))
+        notmuch_tags_valid (tags);
+        notmuch_tags_move_to_next (tags))
     {
        tag = notmuch_tags_get (tags);