#include <gmime/gmime.h>
-#include <xapian.h>
-
struct _notmuch_message {
notmuch_database_t *notmuch;
Xapian::docid doc_id;
char *thread_id;
char *in_reply_to;
char *filename;
+ char *author;
notmuch_message_file_t *message_file;
notmuch_message_list_t *replies;
+ unsigned long flags;
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;
-
/* 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->doc_id = doc_id;
message->frozen = 0;
+ message->flags = 0;
/* Each of these will be lazily created as needed. */
message->message_id = NULL;
message->in_reply_to = NULL;
message->filename = 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,
- * (which may or may not already exist in the databas).
+ * (which may or may not already exist in the database).
*
* 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
{
notmuch_message_t *message;
Xapian::Document doc;
+ Xapian::WritableDatabase *db;
unsigned int doc_id;
char *term;
return NULL;
}
+ if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
+ INTERNAL_ERROR ("Failure to ensure database is writable.");
+
+ 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 = notmuch->xapian_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());
+ notmuch->exception_reported = TRUE;
*status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
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. */
i = message->doc.termlist_begin ();
i.skip_to (prefix);
- in_reply_to = *i;
+ if (i != message->doc.termlist_end ())
+ in_reply_to = *i;
/* It's perfectly valid for a message to have no In-Reply-To
* header. For these cases, we return an empty string. */
in_reply_to = *i;
if (i != message->doc.termlist_end () &&
- strncmp ((*i).c_str (), prefix, prefix_len))
+ strncmp ((*i).c_str (), prefix, prefix_len) == 0)
{
- INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n"
+ INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n",
notmuch_message_get_message_id (message),
message->in_reply_to,
(*i).c_str () + prefix_len);
return message->thread_id;
i = message->doc.termlist_begin ();
-
i.skip_to (prefix);
- id = *i;
+ if (i != message->doc.termlist_end ())
+ id = *i;
if (i == message->doc.termlist_end () || id[0] != *prefix)
INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
return _notmuch_messages_create (message->replies);
}
-/* Set the filename for 'message' to 'filename'.
- *
- * XXX: We should still figure out if we think it's important to store
- * multiple filenames for email messages with identical message IDs.
+/* Add an additional 'filename' for 'message'.
*
* This change will not be reflected in the database until the next
- * call to _notmuch_message_set_sync. */
-void
-_notmuch_message_set_filename (notmuch_message_t *message,
+ * call to _notmuch_message_sync. */
+notmuch_status_t
+_notmuch_message_add_filename (notmuch_message_t *message,
const char *filename)
{
- const char *s;
- const char *db_path;
- unsigned int db_path_len;
+ notmuch_status_t status;
+ void *local = talloc_new (message);
+ char *direntry;
if (message->filename) {
talloc_free (message->filename);
if (filename == NULL)
INTERNAL_ERROR ("Message filename cannot be NULL.");
- s = filename;
+ status = _notmuch_database_filename_to_direntry (local,
+ message->notmuch,
+ filename, &direntry);
+ if (status)
+ return status;
- db_path = notmuch_database_get_path (message->notmuch);
- db_path_len = strlen (db_path);
+ _notmuch_message_add_term (message, "file-direntry", direntry);
- if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
- && strlen (s) > db_path_len)
- {
- s += db_path_len + 1;
- }
+ talloc_free (local);
- message->doc.set_data (s);
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
+char *
+_notmuch_message_talloc_copy_data (notmuch_message_t *message)
+{
+ return talloc_strdup (message, message->doc.get_data ().c_str ());
+}
+
+void
+_notmuch_message_clear_data (notmuch_message_t *message)
+{
+ message->doc.set_data ("");
}
const char *
notmuch_message_get_filename (notmuch_message_t *message)
{
- std::string filename_str;
- const char *db_path;
+ 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;
- filename_str = message->doc.get_data ();
+ 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))
+ {
+ /* A message document created by an old version of notmuch
+ * (prior to rename support) will have the filename in the
+ * data of the document rather than as a file-direntry term.
+ *
+ * It would be nice to do the upgrade of the document directly
+ * here, but the database is likely open in read-only mode. */
+ const char *data;
+
+ data = message->doc.get_data ().c_str ();
+
+ if (data == NULL)
+ INTERNAL_ERROR ("message with no filename");
+
+ message->filename = talloc_strdup (message, data);
+
+ return message->filename;
+ }
+
+ direntry += prefix_len;
+
+ directory_id = strtol (direntry, &colon, 10);
+
+ if (colon == NULL || *colon != ':')
+ INTERNAL_ERROR ("malformed direntry");
+
+ basename = colon + 1;
+
+ *colon = '\0';
+
db_path = notmuch_database_get_path (message->notmuch);
- if (filename_str[0] != '/')
- message->filename = talloc_asprintf (message, "%s/%s", db_path,
- filename_str.c_str ());
+ directory = _notmuch_database_get_directory_path (local,
+ message->notmuch,
+ directory_id);
+
+ if (strlen (directory))
+ message->filename = talloc_asprintf (message, "%s/%s/%s",
+ db_path, directory, basename);
else
- message->filename = talloc_strdup (message, filename_str.c_str ());
+ message->filename = talloc_asprintf (message, "%s/%s",
+ db_path, basename);
+ talloc_free ((void *) directory);
+
+ talloc_free (local);
return message->filename;
}
+notmuch_bool_t
+notmuch_message_get_flag (notmuch_message_t *message,
+ notmuch_message_flag_t flag)
+{
+ return message->flags & (1 << flag);
+}
+
+void
+notmuch_message_set_flag (notmuch_message_t *message,
+ notmuch_message_flag_t flag, notmuch_bool_t enable)
+{
+ if (enable)
+ message->flags |= (1 << flag);
+ else
+ message->flags &= ~(1 << flag);
+}
+
time_t
notmuch_message_get_date (notmuch_message_t *message)
{
notmuch_tags_t *
notmuch_message_get_tags (notmuch_message_t *message)
{
- const char *prefix = _find_prefix ("tag");
Xapian::TermIterator i, end;
- notmuch_tags_t *tags;
- std::string tag;
-
- /* Currently this iteration is written with the assumption that
- * "tag" has a single-character prefix. */
- assert (strlen (prefix) == 1);
-
- tags = _notmuch_tags_create (message);
- if (unlikely (tags == NULL))
- return NULL;
-
- i = message->doc.termlist_begin ();
- end = message->doc.termlist_end ();
-
- i.skip_to (prefix);
-
- while (1) {
- tag = *i;
-
- if (tag.empty () || tag[0] != *prefix)
- break;
-
- _notmuch_tags_add_tag (tags, tag.c_str () + 1);
-
- i++;
- }
+ i = message->doc.termlist_begin();
+ end = message->doc.termlist_end();
+ return _notmuch_convert_tags(message, i, end);
+}
- _notmuch_tags_prepare_iterator (tags);
+const char *
+notmuch_message_get_author (notmuch_message_t *message)
+{
+ return message->author;
+}
- return tags;
+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
/* GMime really doesn't want to see a NULL date, so protect its
* sensibilities. */
- if (date == NULL)
+ if (date == NULL || *date == '\0')
time_value = 0;
else
time_value = g_mime_utils_header_decode_date (date, NULL);
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;
- }
-}
-
+/* Synchronize changes made to message->doc out into the database. */
void
-_notmuch_message_ensure_thread_id (notmuch_message_t *message)
+_notmuch_message_sync (notmuch_message_t *message)
{
- /* If not part of any existing thread, generate a new thread_id. */
- thread_id_t thread_id;
+ Xapian::WritableDatabase *db;
+
+ if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
+ return;
- thread_id_generate (&thread_id);
- _notmuch_message_add_term (message, "thread", thread_id.str);
+ db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
+ db->replace_document (message->doc_id, message->doc);
}
-/* Synchronize changes made to message->doc out into the database. */
+/* Ensure that 'message' is not holding any file object open. Future
+ * calls to various functions will still automatically open the
+ * message file as needed.
+ */
void
-_notmuch_message_sync (notmuch_message_t *message)
+_notmuch_message_close (notmuch_message_t *message)
{
- Xapian::WritableDatabase *db = message->notmuch->xapian_db;
-
- db->replace_document (message->doc_id, message->doc);
+ if (message->message_file) {
+ notmuch_message_file_close (message->message_file);
+ message->message_file = NULL;
+ }
}
/* Add a name:value term to 'message', (the actual term will be
* 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,
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);
* 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,
notmuch_status_t
notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
{
- notmuch_private_status_t status;
+ notmuch_private_status_t private_status;
+ notmuch_status_t status;
+
+ status = _notmuch_database_ensure_writable (message->notmuch);
+ if (status)
+ return status;
if (tag == NULL)
return NOTMUCH_STATUS_NULL_POINTER;
if (strlen (tag) > NOTMUCH_TAG_MAX)
return NOTMUCH_STATUS_TAG_TOO_LONG;
- status = _notmuch_message_add_term (message, "tag", tag);
- if (status) {
+ private_status = _notmuch_message_add_term (message, "tag", tag);
+ if (private_status) {
INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
- status);
+ private_status);
}
if (! message->frozen)
notmuch_status_t
notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
{
- notmuch_private_status_t status;
+ notmuch_private_status_t private_status;
+ notmuch_status_t status;
+
+ status = _notmuch_database_ensure_writable (message->notmuch);
+ if (status)
+ return status;
if (tag == NULL)
return NOTMUCH_STATUS_NULL_POINTER;
if (strlen (tag) > NOTMUCH_TAG_MAX)
return NOTMUCH_STATUS_TAG_TOO_LONG;
- status = _notmuch_message_remove_term (message, "tag", tag);
- if (status) {
+ private_status = _notmuch_message_remove_term (message, "tag", tag);
+ if (private_status) {
INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
- status);
+ private_status);
}
if (! message->frozen)
return NOTMUCH_STATUS_SUCCESS;
}
-void
+notmuch_status_t
notmuch_message_remove_all_tags (notmuch_message_t *message)
{
- notmuch_private_status_t status;
+ notmuch_private_status_t private_status;
+ notmuch_status_t status;
notmuch_tags_t *tags;
const char *tag;
+ status = _notmuch_database_ensure_writable (message->notmuch);
+ if (status)
+ 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);
- status = _notmuch_message_remove_term (message, "tag", tag);
- if (status) {
+ private_status = _notmuch_message_remove_term (message, "tag", tag);
+ if (private_status) {
INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
- status);
+ private_status);
}
}
if (! message->frozen)
_notmuch_message_sync (message);
+
+ return NOTMUCH_STATUS_SUCCESS;
}
-void
+notmuch_status_t
notmuch_message_freeze (notmuch_message_t *message)
{
+ notmuch_status_t status;
+
+ status = _notmuch_database_ensure_writable (message->notmuch);
+ if (status)
+ return status;
+
message->frozen++;
+
+ return NOTMUCH_STATUS_SUCCESS;
}
notmuch_status_t
notmuch_message_thaw (notmuch_message_t *message)
{
+ notmuch_status_t status;
+
+ status = _notmuch_database_ensure_writable (message->notmuch);
+ if (status)
+ return status;
+
if (message->frozen > 0) {
message->frozen--;
if (message->frozen == 0)