X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=message.cc;h=5922cfccff1ae7464df8f78bf0d4da248c19b89f;hp=a2ecda2ddc050f13e340fca36a9530813644f3c5;hb=c7482b4dce114b1c09cbac2f4ef6d0defdb23258;hpb=69b25a75ec8f4a8b27fe25f234a39a7e67287d36 diff --git a/message.cc b/message.cc index a2ecda2d..5922cfcc 100644 --- a/message.cc +++ b/message.cc @@ -27,72 +27,27 @@ struct _notmuch_message { notmuch_database_t *notmuch; Xapian::docid doc_id; char *message_id; + char *thread_id; char *filename; Xapian::Document doc; }; -struct _notmuch_tags { +typedef struct _notmuch_terms { + char prefix_char; Xapian::TermIterator iterator; Xapian::TermIterator iterator_end; -}; - -struct _notmuch_thread_ids { - char *current; - char *next; -}; +} notmuch_terms_t; -#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) - -/* These prefix values are specifically chosen to be compatible - * with sup, (http://sup.rubyforge.org), written by - * William Morgan , and released - * under the GNU GPL v2. - */ - -typedef struct { - const char *name; - const char *prefix; -} prefix_t; - -prefix_t NORMAL_PREFIX[] = { - { "subject", "S" }, - { "body", "B" }, - { "from_name", "FN" }, - { "to_name", "TN" }, - { "name", "N" }, - { "attachment", "A" } -}; - -prefix_t BOOLEAN_PREFIX[] = { - { "type", "K" }, - { "from_email", "FE" }, - { "to_email", "TE" }, - { "email", "E" }, - { "date", "D" }, - { "label", "L" }, - { "tag", "L" }, - { "source_id", "I" }, - { "attachment_extension", "O" }, - { "msgid", "Q" }, - { "thread", "H" }, - { "ref", "R" } +struct _notmuch_tags { + notmuch_terms_t terms; }; -const char * -_find_prefix (const char *name) -{ - unsigned int i; - - for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++) - if (strcmp (name, NORMAL_PREFIX[i].name) == 0) - return NORMAL_PREFIX[i].prefix; - - for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++) - if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0) - return BOOLEAN_PREFIX[i].prefix; - - return ""; -} +/* "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 @@ -122,23 +77,46 @@ _notmuch_message_destructor (notmuch_message_t *message) * 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. + * 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) + unsigned int doc_id, + notmuch_private_status_t *status) { notmuch_message_t *message; + if (status) + *status = NOTMUCH_PRIVATE_STATUS_SUCCESS; + message = talloc (talloc_owner, notmuch_message_t); - if (unlikely (message == NULL)) + if (unlikely (message == NULL)) { + if (status) + *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY; return NULL; + } message->notmuch = notmuch; message->doc_id = doc_id; message->message_id = NULL; /* lazily created */ + message->thread_id = NULL; /* lazily created */ message->filename = NULL; /* lazily created */ + + /* This is C++'s creepy "placement new", which is really just an + * ugly way to call a constructor for a pre-allocated object. So + * it's really not an error to not be checking for OUT_OF_MEMORY + * here, since this "new" isn't actually allocating memory. This + * is language-design comedy of the wrong kind. */ + new (&message->doc) Xapian::Document; talloc_set_destructor (message, _notmuch_message_destructor); @@ -147,9 +125,79 @@ _notmuch_message_create (const void *talloc_owner, message->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; +} + +/* Create a new notmuch_message_t object for a specific message ID, + * (which may or may not already exist in the databas). + * + * 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 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. + * + * If an error occurs, this function will return NULL and *status + * will be set as appropriate. (The status pointer argument must + * not be NULL.) + */ +notmuch_message_t * +_notmuch_message_create_for_message_id (const void *talloc_owner, + notmuch_database_t *notmuch, + const char *message_id, + notmuch_status_t *status) +{ + notmuch_private_status_t private_status; + notmuch_message_t *message; + Xapian::Document doc; + unsigned int doc_id; + char *term; + + *status = NOTMUCH_STATUS_SUCCESS; + + message = notmuch_database_find_message (notmuch, message_id); + if (message) + return talloc_steal (talloc_owner, message); + + term = talloc_asprintf (NULL, "%s%s", + _find_prefix ("id"), message_id); + if (term == NULL) { + *status = NOTMUCH_STATUS_OUT_OF_MEMORY; + return NULL; + } + + try { + doc.add_term (term); + talloc_free (term); + + doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id); + + doc_id = notmuch->xapian_db->add_document (doc); + } catch (const Xapian::Error &error) { + *status = NOTMUCH_STATUS_XAPIAN_EXCEPTION; return NULL; } + message = _notmuch_message_create (talloc_owner, notmuch, + doc_id, &private_status); + + *status = COERCE_STATUS (private_status, + "Failed to find dcocument after inserting it."); + return message; } @@ -162,24 +210,65 @@ notmuch_message_get_message_id (notmuch_message_t *message) return message->message_id; i = message->doc.termlist_begin (); - i.skip_to (_find_prefix ("msgid")); + i.skip_to (_find_prefix ("id")); - /* XXX: This should really be an internal error, but we'll need to - * fix the add_message side of things first. */ if (i == message->doc.termlist_end ()) - return NULL; + INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n", + message->doc_id); message->message_id = talloc_strdup (message, (*i).c_str () + 1); + +#if DEBUG_DATABASE_SANITY + i++; + + if (i != message->doc.termlist_end () && + strncmp ((*i).c_str (), _find_prefix ("id"), + strlen (_find_prefix ("id"))) == 0) + { + INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs", + message->doc_id); + } +#endif + return message->message_id; } +const char * +notmuch_message_get_thread_id (notmuch_message_t *message) +{ + Xapian::TermIterator i; + + if (message->thread_id) + return message->thread_id; + + i = message->doc.termlist_begin (); + i.skip_to (_find_prefix ("thread")); + + if (i == message->doc.termlist_end ()) + INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n", + message->doc_id); + + message->thread_id = talloc_strdup (message, (*i).c_str () + 1); + +#if DEBUG_DATABASE_SANITY + i++; + + if (i != message->doc.termlist_end () && + strncmp ((*i).c_str (), _find_prefix ("thread"), + strlen (_find_prefix ("thread"))) == 0) + { + INTERNAL_ERROR ("Message with document ID of %d has duplicate thread IDs.\n", + message->doc_id); + } +#endif + + return message->thread_id; +} + /* Set the filename for 'message' to 'filename'. * - * XXX: We should still figure out what we want to do for multiple - * files with identical message IDs. We will probably want to store a - * list of filenames here, (so that this will be "add_filename" - * instead of "set_filename"). Which would make this very similar to - * add_thread_ids. + * XXX: We should still figure out if we think it's important to store + * multiple filenames for email messages with identical message IDs. * * This change will not be reflected in the database until the next * call to _notmuch_message_set_sync. */ @@ -213,52 +302,57 @@ notmuch_message_get_filename (notmuch_message_t *message) * talloc_set_destructor at all otherwise). */ static int -_notmuch_tags_destructor (notmuch_tags_t *tags) +_notmuch_terms_destructor (notmuch_terms_t *terms) { - tags->iterator.~TermIterator (); - tags->iterator_end.~TermIterator (); + terms->iterator.~TermIterator (); + terms->iterator_end.~TermIterator (); return 0; } -notmuch_tags_t * -notmuch_message_get_tags (notmuch_message_t *message) +static notmuch_terms_t * +_notmuch_terms_create (void *ctx, + Xapian::Document doc, + const char *prefix_name) { - notmuch_tags_t *tags; + notmuch_terms_t *terms; + const char *prefix = _find_prefix (prefix_name); + + /* Currently, notmuch_terms_t is written with the assumption that + * any prefix its derivatives use will be only a single + * character. */ + assert (strlen (prefix) == 1); - tags = talloc (message, notmuch_tags_t); - if (unlikely (tags == NULL)) + terms = talloc (ctx, notmuch_terms_t); + if (unlikely (terms == NULL)) return NULL; - new (&tags->iterator) Xapian::TermIterator; - new (&tags->iterator_end) Xapian::TermIterator; + terms->prefix_char = *prefix; + new (&terms->iterator) Xapian::TermIterator; + new (&terms->iterator_end) Xapian::TermIterator; - talloc_set_destructor (tags, _notmuch_tags_destructor); + talloc_set_destructor (terms, _notmuch_terms_destructor); - tags->iterator = message->doc.termlist_begin (); - tags->iterator.skip_to (_find_prefix ("tag")); - tags->iterator_end = message->doc.termlist_end (); + terms->iterator = doc.termlist_begin (); + terms->iterator.skip_to (prefix); + terms->iterator_end = doc.termlist_end (); - return tags; + return terms; } -notmuch_thread_ids_t * -notmuch_message_get_thread_ids (notmuch_message_t *message) -{ - notmuch_thread_ids_t *thread_ids; - std::string id_str; - - thread_ids = talloc (message, notmuch_thread_ids_t); - if (unlikely (thread_ids == NULL)) - return NULL; - - id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD); - thread_ids->next = talloc_strdup (message, id_str.c_str ()); +/* The assertion is to ensure that 'type' is a derivative of + * notmuch_terms_t in that it contains a notmuch_terms_t as its first + * member. We do this by name of 'terms' as opposed to type, because + * that's as clever as I've been so far. */ +#define _notmuch_terms_create_type(ctx, doc, prefix_name, type) \ + (COMPILE_TIME_ASSERT(offsetof(type, terms) == 0), \ + (type *) _notmuch_terms_create (ctx, doc, prefix_name)) - /* Initialize thread_ids->current and terminate first ID. */ - notmuch_thread_ids_advance (thread_ids); - - return thread_ids; +notmuch_tags_t * +notmuch_message_get_tags (notmuch_message_t *message) +{ + return _notmuch_terms_create_type (message, message->doc, "tag", + notmuch_tags_t); } void @@ -269,36 +363,10 @@ _notmuch_message_set_date (notmuch_message_t *message, time_value = notmuch_parse_date (date, NULL); - message->doc.add_value (NOTMUCH_VALUE_DATE, + message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP, Xapian::sortable_serialise (time_value)); } -void -_notmuch_message_add_thread_id (notmuch_message_t *message, - const char *thread_id) -{ - std::string id_str; - - _notmuch_message_add_term (message, "thread", thread_id); - - id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD); - - if (id_str.empty ()) { - message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id); - } else { - size_t pos; - - /* Think about using a hash here if there's any performance - * problem. */ - pos = id_str.find (thread_id); - if (pos == std::string::npos) { - id_str.append (","); - id_str.append (thread_id); - message->doc.add_value (NOTMUCH_VALUE_THREAD, id_str); - } - } -} - static void thread_id_generate (thread_id_t *thread_id) { @@ -336,7 +404,6 @@ _notmuch_message_ensure_thread_id (notmuch_message_t *message) thread_id_generate (&thread_id); _notmuch_message_add_term (message, "thread", thread_id.str); - message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str); } /* Synchronize changes made to message->doc out into the database. */ @@ -422,9 +489,8 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag) status = _notmuch_message_add_term (message, "tag", tag); if (status) { - fprintf (stderr, "Internal error: _notmuch_message_add_term return unexpected value: %d\n", - status); - exit (1); + INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n", + status); } _notmuch_message_sync (message); @@ -445,9 +511,8 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag) status = _notmuch_message_remove_term (message, "tag", tag); if (status) { - fprintf (stderr, "Internal error: _notmuch_message_remove_term return unexpected value: %d\n", - status); - exit (1); + INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n", + status); } _notmuch_message_sync (message); @@ -461,62 +526,59 @@ notmuch_message_destroy (notmuch_message_t *message) talloc_free (message); } -notmuch_bool_t -notmuch_tags_has_more (notmuch_tags_t *tags) +static notmuch_bool_t +_notmuch_terms_has_more (notmuch_terms_t *terms) { std::string s; - if (tags->iterator == tags->iterator_end) + if (terms->iterator == terms->iterator_end) return FALSE; - s = *tags->iterator; - if (s.size () && s[0] == 'L') + s = *terms->iterator; + if (! s.empty () && s[0] == terms->prefix_char) return TRUE; else return FALSE; } -const char * -notmuch_tags_get (notmuch_tags_t *tags) +static const char * +_notmuch_terms_get (notmuch_terms_t *terms) { - return talloc_strdup (tags, (*tags->iterator).c_str () + 1); + return talloc_strdup (terms, (*terms->iterator).c_str () + 1); } -void -notmuch_tags_advance (notmuch_tags_t *tags) +static void +_notmuch_terms_advance (notmuch_terms_t *terms) { - tags->iterator++; + terms->iterator++; } -void -notmuch_tags_destroy (notmuch_tags_t *tags) +static void +_notmuch_terms_destroy (notmuch_terms_t *terms) { - talloc_free (tags); + talloc_free (terms); } notmuch_bool_t -notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids) +notmuch_tags_has_more (notmuch_tags_t *tags) { - if (thread_ids->current == NULL || *thread_ids->current == '\0') - return FALSE; - else - return TRUE; + return _notmuch_terms_has_more (&tags->terms); } const char * -notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids) +notmuch_tags_get (notmuch_tags_t *tags) { - return thread_ids->current; + return _notmuch_terms_get (&tags->terms); } void -notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids) +notmuch_tags_advance (notmuch_tags_t *tags) { - thread_ids->current = strsep (&thread_ids->next, ","); + return _notmuch_terms_advance (&tags->terms); } void -notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids) +notmuch_tags_destroy (notmuch_tags_t *tags) { - talloc_free (thread_ids); + return _notmuch_terms_destroy (&tags->terms); }