#include <gmime/gmime.h>
-#include <xapian.h>
-
struct _notmuch_message {
notmuch_database_t *notmuch;
Xapian::docid doc_id;
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;
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 */
+static 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
* block that we allocated with talloc. So C++ is making talloc
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;
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)) {
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,
* 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
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());
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. */
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)
{
/* 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)
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)
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.
+ */
+static 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)
{
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
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);
+
+ _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 message->filename;
+ return _notmuch_filenames_create (message, message->filename_list);
}
notmuch_bool_t
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)
* 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,
* 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,
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;
+ int seen_maildir_info = 0;
+
+ 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;
+
+ 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;
+
+ 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;
+}
+
+/* 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
+_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;
+
+ 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) {
+ 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);
+ }
+ }
+ }
+
+ /* 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);
+ }
+ }
+
+ *to_set_ret = to_set;
+ *to_clear_ret = to_clear;
+}
+
+/* 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)
+{
+ 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--;
+ }
+ }
+
+ 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;
+}
+
+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 = NOTMUCH_STATUS_SUCCESS;
+
+ _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);
+ }
+
+ talloc_free (filename_new);
+ }
+
+ talloc_free (to_set);
+ talloc_free (to_clear);
+
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
notmuch_status_t
notmuch_message_remove_all_tags (notmuch_message_t *message)
{
projects / notmuch / blobdiff