unsigned long flags;
Xapian::Document doc;
+ Xapian::termcount termpos;
};
#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
};
/* ASCII ordered table of Maildir flags and associated tags */
-struct maildir_flag_tag flag2tag[] = {
+static struct maildir_flag_tag flag2tag[] = {
{ 'D', "draft", false},
{ 'F', "flagged", false},
{ 'P', "passed", false},
talloc_set_destructor (message, _notmuch_message_destructor);
message->doc = doc;
+ message->termpos = 0;
return message;
}
*
* 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
+ * calling notmuch_message_destroy on the message, and know that all
+ * memory will be reclaimed when 'talloc_owner' is freed. The caller
* still can call notmuch_message_destroy when finished with the
* message if desired.
*
return message;
}
+unsigned int
+_notmuch_message_get_doc_id (notmuch_message_t *message)
+{
+ return message->doc_id;
+}
+
const char *
notmuch_message_get_message_id (notmuch_message_t *message)
{
_notmuch_message_add_filename (notmuch_message_t *message,
const char *filename)
{
+ const char *relative, *directory;
notmuch_status_t status;
void *local = talloc_new (message);
char *direntry;
+ if (filename == NULL)
+ INTERNAL_ERROR ("Message filename cannot be NULL.");
+
if (message->filename_list) {
_notmuch_filename_list_destroy (message->filename_list);
message->filename_list = NULL;
}
- if (filename == NULL)
- INTERNAL_ERROR ("Message filename cannot be NULL.");
+ relative = _notmuch_database_relative_path (message->notmuch, filename);
+
+ status = _notmuch_database_split_path (local, relative, &directory, NULL);
+ if (status)
+ return status;
status = _notmuch_database_filename_to_direntry (local,
message->notmuch,
if (status)
return status;
+ /* New file-direntry allows navigating to this message with
+ * notmuch_directory_get_child_files() . */
_notmuch_message_add_term (message, "file-direntry", direntry);
+ /* New terms allow user to search with folder: specification. */
+ _notmuch_message_gen_terms (message, "folder", directory);
+
talloc_free (local);
return NOTMUCH_STATUS_SUCCESS;
}
+/* Remove a particular 'filename' from 'message'.
+ *
+ * This change will not be reflected in the database until the next
+ * call to _notmuch_message_sync.
+ *
+ * Note: This function does not remove a document from the database,
+ * even if the specified filename is the only filename for this
+ * message. For that functionality, see
+ * _notmuch_database_remove_message. */
+notmuch_status_t
+_notmuch_message_remove_filename (notmuch_message_t *message,
+ const char *filename)
+{
+ const char *direntry_prefix = _find_prefix ("file-direntry");
+ int direntry_prefix_len = strlen (direntry_prefix);
+ const char *folder_prefix = _find_prefix ("folder");
+ int folder_prefix_len = strlen (folder_prefix);
+ void *local = talloc_new (message);
+ char *direntry;
+ notmuch_private_status_t private_status;
+ notmuch_status_t status;
+ Xapian::TermIterator i, last;
+
+ if (message->filename_list) {
+ _notmuch_filename_list_destroy (message->filename_list);
+ message->filename_list = NULL;
+ }
+
+ status = _notmuch_database_filename_to_direntry (local, message->notmuch,
+ filename, &direntry);
+ if (status)
+ return status;
+
+ /* Unlink this file from its parent directory. */
+ private_status = _notmuch_message_remove_term (message,
+ "file-direntry", direntry);
+ status = COERCE_STATUS (private_status,
+ "Unexpected error from _notmuch_message_remove_term");
+
+ /* Re-synchronize "folder:" terms for this message. This requires
+ * first removing all "folder:" terms, then adding back terms for
+ * all remaining filenames of the message. */
+ while (1) {
+ i = message->doc.termlist_begin ();
+ i.skip_to (folder_prefix);
+
+ /* Terminate loop when no terms remain with desired prefix. */
+ if (i == message->doc.termlist_end () ||
+ strncmp ((*i).c_str (), folder_prefix, folder_prefix_len))
+ {
+ break;
+ }
+
+ try {
+ message->doc.remove_term ((*i));
+ } catch (const Xapian::InvalidArgumentError) {
+ /* Ignore failure to remove non-existent term. */
+ }
+ }
+
+ i = message->doc.termlist_begin ();
+ i.skip_to (direntry_prefix);
+
+ for (; i != message->doc.termlist_end (); i++) {
+ unsigned int directory_id;
+ const char *direntry, *directory;
+ char *colon;
+
+ /* Terminate loop at first term without desired prefix. */
+ if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
+ break;
+
+ direntry = (*i).c_str ();
+ direntry += direntry_prefix_len;
+
+ directory_id = strtol (direntry, &colon, 10);
+
+ if (colon == NULL || *colon != ':')
+ INTERNAL_ERROR ("malformed direntry");
+
+ directory = _notmuch_database_get_directory_path (local,
+ message->notmuch,
+ directory_id);
+ if (strlen (directory))
+ _notmuch_message_gen_terms (message, "folder", directory);
+ }
+
+ talloc_free (local);
+
+ return status;
+}
+
char *
_notmuch_message_talloc_copy_data (notmuch_message_t *message)
{
return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
term_gen->set_document (message->doc);
+ term_gen->set_termpos (message->termpos);
if (prefix_name) {
const char *prefix = _find_prefix (prefix_name);
term_gen->index_text (text, 1, prefix);
+ message->termpos = term_gen->get_termpos ();
}
term_gen->index_text (text);
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)
{
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';
+
+ *to_set_ret = to_set;
+ *to_clear_ret = to_clear;
}
-static char *
-maildir_get_subdir (char *filename)
+/* 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".
+ *
+ * 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).
+ */
+static char*
+_new_maildir_filename (void *ctx,
+ const char *filename,
+ const char *flags_to_set,
+ const char *flags_to_clear)
{
- 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;
+ 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;
+
+ memset (flag_map, 0, sizeof (flag_map));
+
+ 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++;
+ }
+ }
+
+ /* 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--;
+ }
}
- return subdir;
+
+ filename_new = (char *) talloc_size (ctx,
+ info - filename +
+ strlen (":2,") + flags_in_map + 1);
+ if (unlikely (filename_new == NULL))
+ return NULL;
+
+ strncpy (filename_new, filename, info - filename);
+ filename_new[info - filename] = '\0';
+
+ strcat (filename_new, ":2,");
+
+ 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/. */
+ dir = (char *) _filename_is_in_maildir (filename_new);
+ if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
+ memcpy (dir, "cur/", 4);
+
+ return filename_new;
}
-/* 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)
{
notmuch_filenames_t *filenames;
- char flags[ARRAY_SIZE(flag2tag)+1];
- const char *filename, *p;
- char *filename_new, *subdir = NULL;
- int ret;
+ const char *filename;
+ char *filename_new;
+ char *to_set, *to_clear;
+ notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
- maildir_get_new_flags (message, flags);
+ _get_maildir_flag_actions (message, &to_set, &to_clear);
for (filenames = notmuch_message_get_filenames (message);
notmuch_filenames_valid (filenames);
{
filename = notmuch_filenames_get (filenames);
- p = strstr(filename, ":2,");
- if ((p && strcmp (p+3, flags) == 0) ||
- (!p && flags[0] == '\0'))
- {
+ if (! _filename_is_in_maildir (filename))
continue;
- }
-
- 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) {
- notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+ filename_new = _new_maildir_filename (message, filename,
+ to_set, to_clear);
+ if (filename_new == NULL)
+ continue;
- ret = rename (filename, filename_new);
- if (ret == 0)
- status = _notmuch_message_rename (message, filename_new);
+ if (strcmp (filename, filename_new)) {
+ int err;
+ notmuch_status_t new_status;
+
+ err = rename (filename, filename_new);
+ if (err)
+ continue;
+
+ new_status = _notmuch_message_remove_filename (message,
+ filename);
+ /* Hold on to only the first error. */
+ if (! status && new_status) {
+ status = new_status;
+ continue;
+ }
+
+ new_status = _notmuch_message_add_filename (message,
+ filename_new);
+ /* Hold on to only the first error. */
+ if (! status && new_status) {
+ status = new_status;
+ continue;
+ }
_notmuch_message_sync (message);
-
- if (status)
- return status;
}
+
+ talloc_free (filename_new);
}
+ talloc_free (to_set);
+ talloc_free (to_clear);
+
return NOTMUCH_STATUS_SUCCESS;
}