]> git.notmuchmail.org Git - notmuch/blobdiff - lib/message.cc
tags_to_maildir_flags: Fix to preserve existing, unsupported flags
[notmuch] / lib / message.cc
index bc9cd2592adb27e9c0440bf75c41ea9a59bf4fe1..c2da25c953a46d04e82473cd921ad581495ba4e9 100644 (file)
@@ -32,7 +32,7 @@ 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;
@@ -101,7 +101,7 @@ _notmuch_message_create_for_document (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;
 
@@ -432,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)
@@ -453,6 +453,41 @@ _notmuch_message_add_filename (notmuch_message_t *message,
     return NOTMUCH_STATUS_SUCCESS;
 }
 
+/* Change a particular filename for 'message' from 'old_filename' to
+ * 'new_filename'
+ *
+ * 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 *old_filename,
+                        const char *new_filename)
+{
+    void *local = talloc_new (message);
+    char *direntry;
+    notmuch_private_status_t private_status;
+    notmuch_status_t status;
+
+    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;
+}
+
 char *
 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
 {
@@ -465,28 +500,23 @@ _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 *colon, *direntry = NULL;
-    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
@@ -501,39 +531,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;
 
-    directory_id = strtol (direntry, &colon, 10);
+       /* Terminate loop at first term without desired prefix. */
+       if (strncmp ((*i).c_str (), prefix, prefix_len))
+           break;
 
-    if (colon == NULL || *colon != ':')
-       INTERNAL_ERROR ("malformed direntry");
+       direntry = talloc_strdup (local, (*i).c_str ());
 
-    basename = colon + 1;
+       direntry += prefix_len;
 
-    *colon = '\0';
+       directory_id = strtol (direntry, &colon, 10);
 
-    db_path = notmuch_database_get_path (message->notmuch);
+       if (colon == NULL || *colon != ':')
+           INTERNAL_ERROR ("malformed direntry");
 
-    directory = _notmuch_database_get_directory_path (local,
-                                                     message->notmuch,
-                                                     directory_id);
+       basename = colon + 1;
 
-    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);
+       *colon = '\0';
 
-    talloc_free (local);
+       db_path = notmuch_database_get_path (message->notmuch);
+
+       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
@@ -730,46 +798,6 @@ _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)
 {
@@ -826,53 +854,48 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
     return NOTMUCH_STATUS_SUCCESS;
 }
 
-/* XXX: Needs to iterate over all message filenames. */
 notmuch_status_t
 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
 {
-    const char *flags, *p;
-    char f;
-    bool valid, unread;
-    unsigned i;
+    const char *flags;
     notmuch_status_t status;
+    notmuch_filenames_t *filenames;
     const char *filename;
+    char *combined_flags = talloc_strdup (message, "");
+    unsigned i;
+    int seen_maildir_info = 0;
 
-    filename = notmuch_message_get_filename (message);
+    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)
-       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;
+       flags = strstr (filename, ":2,");
+       if (! flags)
+           continue;
+
+       seen_maildir_info = 1;
+       flags += 3;
+
+       combined_flags = talloc_strdup_append (combined_flags, flags);
     }
 
+    /* If none of the filenames have any maildir info field (not even
+     * an empty info with no flags set) then there's no information to
+     * go on, so do nothing. */
+    if (! seen_maildir_info)
+       return NOTMUCH_STATUS_SUCCESS;
+
     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) {
+       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);
@@ -882,109 +905,266 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
     }
     status = notmuch_message_thaw (message);
 
+    talloc_free (combined_flags);
+
     return status;
 }
 
+/* Is the given filename within a maildir directory?
+ *
+ * Specifically, is the final directory component of 'filename' either
+ * "cur" or "new". If so, return a pointer to that final directory
+ * component within 'filename'. If not, return NULL.
+ *
+ * A non-NULL return value is guaranteed to be a valid string pointer
+ * pointing to the characters "new/" or "cur/", (but not
+ * NUL-terminated).
+ */
+static const char *
+_filename_is_in_maildir (const char *filename)
+{
+    const char *slash, *dir = NULL;
+
+    /* Find the last '/' separating directory from filename. */
+    slash = strrchr (filename, '/');
+    if (slash == NULL)
+       return NULL;
+
+    /* Jump back 4 characters to where the previous '/' will be if the
+     * directory is named "cur" or "new". */
+    if (slash - filename < 4)
+       return NULL;
+
+    slash -= 4;
+
+    if (*slash != '/')
+       return NULL;
+
+    dir = slash + 1;
+
+    if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
+       STRNCMP_LITERAL (dir, "new/") == 0)
+    {
+       return dir;
+    }
+
+    return NULL;
+}
+
+/* From the set of tags on 'message' and the flag2tag table, compute a
+ * set of maildir-flag actions to be taken, (flags that should be
+ * either set or cleared).
+ *
+ * The result is returned as two talloced strings: to_set, and to_clear
+ */
 static void
-maildir_get_new_flags(notmuch_message_t *message, char *flags)
+_get_maildir_flag_actions (notmuch_message_t *message,
+                          char **to_set_ret,
+                          char **to_clear_ret)
 {
+    char *to_set, *to_clear;
     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';
+    to_set = talloc_strdup (message, "");
+    to_clear = talloc_strdup (message, "");
 
+    /* First, find flags for all set tags. */
     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;
+
+       for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
+           if (strcmp (tag, flag2tag[i].tag) == 0) {
+               if (flag2tag[i].inverse)
+                   to_clear = talloc_asprintf_append (to_clear,
+                                                      "%c",
+                                                      flag2tag[i].flag);
+               else
+                   to_set = talloc_asprintf_append (to_set,
+                                                    "%c",
+                                                    flag2tag[i].flag);
+           }
        }
     }
 
-    p = flags;
-    for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
-       if (flags[i])
-           *p++ = flags[i];
+    /* Then, find the flags for all tags not present. */
+    for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
+       if (flag2tag[i].inverse) {
+           if (strchr (to_clear, flag2tag[i].flag) == NULL)
+               to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
+       } else {
+           if (strchr (to_set, flag2tag[i].flag) == NULL)
+               to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
+       }
     }
-    *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;
+    *to_set_ret = to_set;
+    *to_clear_ret = to_clear;
 }
 
-/* XXX: Needs to iterate over all filenames in the message
+/* Given 'filename' and a set of maildir flags to set and to clear,
+ * compute the new maildir filename.
+ *
+ * If the existing filename is in the directory "new", the new
+ * filename will be in the directory "cur".
  *
- * XXX: Needs to ensure that existing, unsupported flags in the
- *      filename are left unchanged (which also needs a test in the
- *      test suite).
+ * After a sequence of ":2," in the filename, any subsequent
+ * single-character flags will be added or removed according to the
+ * characters in flags_to_set and flags_to_clear. Any existing flags
+ * not mentioned in either string will remain. The final list of flags
+ * will be in ASCII order.
+ *
+ * If the original flags seem invalid, (repeated characters or
+ * non-ASCII ordering of flags), this function will return NULL
+ * (meaning that renaming would not be safe and should not occur).
  */
-notmuch_status_t
-notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
+static char*
+_new_maildir_filename (void *ctx,
+                      const char *filename,
+                      const char *flags_to_set,
+                      const char *flags_to_clear)
 {
-    char flags[ARRAY_SIZE(flag2tag)+1];
-    const char *filename, *p;
-    char *filename_new, *subdir = NULL;
-    int ret;
+    const char *info, *flags;
+    unsigned int flag, last_flag;
+    char *filename_new, *dir;
+    char flag_map[128];
+    int flags_in_map = 0;
+    unsigned int i;
+    char *s;
 
-    maildir_get_new_flags (message, flags);
+    memset (flag_map, 0, sizeof (flag_map));
 
-    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;
+    info = strstr (filename, ":2,");
+
+    if (info == NULL) {
+       info = filename + strlen(filename);
+    } else {
+       flags = info + 3;
+
+       /* Loop through existing flags in filename. */
+       for (flags = info + 3, last_flag = 0;
+            *flags;
+            last_flag = flag, flags++)
+       {
+           flag = *flags;
+
+           /* Original flags not in ASCII order. Abort. */
+           if (flag < last_flag)
+               return NULL;
+
+           /* Non-ASCII flag. Abort. */
+           if (flag > sizeof(flag_map) - 1)
+               return NULL;
+
+           /* Repeated flag value. Abort. */
+           if (flag_map[flag])
+               return NULL;
+
+           flag_map[flag] = 1;
+           flags_in_map++;
+       }
     }
-    if (!p)
-       p = filename + strlen(filename);
 
-    filename_new = (char*)talloc_size(message, (p-filename) + 3 + sizeof(flags));
+    /* Then set and clear our flags from tags. */
+    for (flags = flags_to_set; *flags; flags++) {
+       flag = *flags;
+       if (flag_map[flag] == 0) {
+           flag_map[flag] = 1;
+           flags_in_map++;
+       }
+    }
+
+    for (flags = flags_to_clear; *flags; flags++) {
+       flag = *flags;
+       if (flag_map[flag]) {
+           flag_map[flag] = 0;
+           flags_in_map--;
+       }
+    }
+
+    filename_new = (char *) talloc_size (ctx,
+                                        info - filename +
+                                        strlen (":2,") + flags_in_map + 1);
     if (unlikely (filename_new == NULL))
-       return NOTMUCH_STATUS_OUT_OF_MEMORY;
+       return NULL;
+
+    strncpy (filename_new, filename, info - filename);
+    filename_new[info - filename] = '\0';
+
+    strcat (filename_new, ":2,");
 
-    memcpy(filename_new, filename, p-filename);
-    filename_new[p-filename] = '\0';
+    s = filename_new + strlen (filename_new);
+    for (i = 0; i < sizeof (flag_map); i++)
+    {
+       if (flag_map[i]) {
+           *s = i;
+           s++;
+       }
+    }
+    *s = '\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);
+    dir = (char *) _filename_is_in_maildir (filename_new);
+    if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
+       memcpy (dir, "cur/", 4);
+
+    return filename_new;
+}
+
+notmuch_status_t
+notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
+{
+    notmuch_filenames_t *filenames;
+    const char *filename;
+    char *filename_new;
+    char *to_set, *to_clear;
+    notmuch_status_t status;
+
+    _get_maildir_flag_actions (message, &to_set, &to_clear);
+
+    for (filenames = notmuch_message_get_filenames (message);
+        notmuch_filenames_valid (filenames);
+        notmuch_filenames_move_to_next (filenames))
+    {
+       filename = notmuch_filenames_get (filenames);
+
+       if (! _filename_is_in_maildir (filename))
+           continue;
+
+       filename_new = _new_maildir_filename (message, filename,
+                                             to_set, to_clear);
+       if (filename_new == NULL)
+           continue;
+
+       if (strcmp (filename, filename_new)) {
+           int err;
+           notmuch_status_t new_status;
+
+           err = rename (filename, filename_new);
+           if (err)
+               continue;
+
+           new_status = _notmuch_message_rename (message,
+                                                 filename, filename_new);
+           /* Hold on to only the first error. */
+           if (! status && new_status) {
+               status = new_status;
+               continue;
+           }
+
+           _notmuch_message_sync (message);
        }
-       return _notmuch_message_rename (message, filename_new);
-       /* _notmuch_message_sync is our caller. Do not call it here. */
+
+       talloc_free (filename_new);
     }
+
+    talloc_free (to_set);
+    talloc_free (to_clear);
+
     return NOTMUCH_STATUS_SUCCESS;
 }