1 /* database.cc - The database interfaces of the notmuch mail library
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "database-private.h"
22 #include "parse-time-vrp.h"
31 #include <glib.h> /* g_free, GPtrArray, GHashTable */
32 #include <glib-object.h> /* g_type_init */
34 #include <gmime/gmime.h> /* g_mime_init */
38 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
45 #define NOTMUCH_DATABASE_VERSION 1
47 #define STRINGIFY(s) _SUB_STRINGIFY(s)
48 #define _SUB_STRINGIFY(s) #s
50 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
52 * We currently have two different types of documents (mail and
53 * directory) and also some metadata.
57 * A mail document is associated with a particular email message file
58 * on disk. It is indexed with the following prefixed terms which the
59 * database uses to construct threads, etc.:
61 * Single terms of given prefix:
65 * id: Unique ID of mail. This is from the Message-ID header
66 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
67 * If it's present and too long, then we use
68 * "notmuch-sha1-<sha1_sum_of_message_id>".
69 * If this header is not present, we use
70 * "notmuch-sha1-<sha1_sum_of_entire_file>".
72 * thread: The ID of the thread to which the mail belongs
74 * replyto: The ID from the In-Reply-To header of the mail (if any).
76 * Multiple terms of given prefix:
78 * reference: All message IDs from In-Reply-To and References
79 * headers in the message.
81 * tag: Any tags associated with this message by the user.
83 * file-direntry: A colon-separated pair of values
84 * (INTEGER:STRING), where INTEGER is the
85 * document ID of a directory document, and
86 * STRING is the name of a file within that
87 * directory for this mail message.
89 * A mail document also has four values:
91 * TIMESTAMP: The time_t value corresponding to the message's
94 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
96 * FROM: The value of the "From" header
98 * SUBJECT: The value of the "Subject" header
100 * In addition, terms from the content of the message are added with
101 * "from", "to", "attachment", and "subject" prefixes for use by the
102 * user in searching. Similarly, terms from the path of the mail
103 * message are added with a "folder" prefix. But the database doesn't
104 * really care itself about any of these.
106 * The data portion of a mail document is empty.
110 * A directory document is used by a client of the notmuch library to
111 * maintain data necessary to allow for efficient polling of mail
114 * All directory documents contain one term:
116 * directory: The directory path (relative to the database path)
117 * Or the SHA1 sum of the directory path (if the
118 * path itself is too long to fit in a Xapian
121 * And all directory documents for directories other than top-level
122 * directories also contain the following term:
124 * directory-direntry: A colon-separated pair of values
125 * (INTEGER:STRING), where INTEGER is the
126 * document ID of the parent directory
127 * document, and STRING is the name of this
128 * directory within that parent.
130 * All directory documents have a single value:
132 * TIMESTAMP: The mtime of the directory (at last scan)
134 * The data portion of a directory document contains the path of the
135 * directory (relative to the database path).
139 * Xapian allows us to store arbitrary name-value pairs as
140 * "metadata". We currently use the following metadata names with the
143 * version The database schema version, (which is distinct
144 * from both the notmuch package version (see
145 * notmuch --version) and the libnotmuch library
146 * version. The version is stored as an base-10
147 * ASCII integer. The initial database version
148 * was 1, (though a schema existed before that
149 * were no "version" database value existed at
150 * all). Successive versions are allocated as
151 * changes are made to the database (such as by
152 * indexing new fields).
154 * last_thread_id The last thread ID generated. This is stored
155 * as a 16-byte hexadecimal ASCII representation
156 * of a 64-bit unsigned integer. The first ID
157 * generated is 1 and the value will be
158 * incremented for each thread ID.
160 * thread_id_* A pre-allocated thread ID for a particular
161 * message. This is actually an arbitrarily large
162 * family of metadata name. Any particular name is
163 * formed by concatenating "thread_id_" with a message
164 * ID (or the SHA1 sum of a message ID if it is very
165 * long---see description of 'id' in the mail
166 * document). The value stored is a thread ID.
168 * These thread ID metadata values are stored
169 * whenever a message references a parent message
170 * that does not yet exist in the database. A
171 * thread ID will be allocated and stored, and if
172 * the message is later added, the stored thread
173 * ID will be used (and the metadata value will
176 * Even before a message is added, it's
177 * pre-allocated thread ID is useful so that all
178 * descendant messages that reference this common
179 * parent can be recognized as belonging to the
183 /* With these prefix values we follow the conventions published here:
185 * http://xapian.org/docs/omega/termprefixes.html
187 * as much as makes sense. Note that I took some liberty in matching
188 * the reserved prefix values to notmuch concepts, (for example, 'G'
189 * is documented as "newsGroup (or similar entity - e.g. a web forum
190 * name)", for which I think the thread is the closest analogue in
191 * notmuch. This in spite of the fact that we will eventually be
192 * storing mailing-list messages where 'G' for "mailing list name"
193 * might be even a closer analogue. I'm treating the single-character
194 * prefixes preferentially for core notmuch concepts (which will be
195 * nearly universal to all mail messages).
198 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
200 { "reference", "XREFERENCE" },
201 { "replyto", "XREPLYTO" },
202 { "directory", "XDIRECTORY" },
203 { "file-direntry", "XFDIRENTRY" },
204 { "directory-direntry", "XDDIRENTRY" },
207 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
214 static prefix_t PROBABILISTIC_PREFIX[]= {
217 { "attachment", "XATTACHMENT" },
218 { "subject", "XSUBJECT"},
219 { "folder", "XFOLDER"}
223 _find_prefix (const char *name)
227 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
228 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
229 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
232 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
233 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
234 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
237 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
238 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
239 return PROBABILISTIC_PREFIX[i].prefix;
242 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
248 notmuch_status_to_string (notmuch_status_t status)
251 case NOTMUCH_STATUS_SUCCESS:
252 return "No error occurred";
253 case NOTMUCH_STATUS_OUT_OF_MEMORY:
254 return "Out of memory";
255 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
256 return "Attempt to write to a read-only database";
257 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
258 return "A Xapian exception occurred";
259 case NOTMUCH_STATUS_FILE_ERROR:
260 return "Something went wrong trying to read or write a file";
261 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
262 return "File is not an email";
263 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
264 return "Message ID is identical to a message in database";
265 case NOTMUCH_STATUS_NULL_POINTER:
266 return "Erroneous NULL pointer";
267 case NOTMUCH_STATUS_TAG_TOO_LONG:
268 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
269 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
270 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
271 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
272 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
273 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
274 return "Unsupported operation";
276 case NOTMUCH_STATUS_LAST_STATUS:
277 return "Unknown error status value";
282 find_doc_ids_for_term (notmuch_database_t *notmuch,
284 Xapian::PostingIterator *begin,
285 Xapian::PostingIterator *end)
287 *begin = notmuch->xapian_db->postlist_begin (term);
289 *end = notmuch->xapian_db->postlist_end (term);
293 find_doc_ids (notmuch_database_t *notmuch,
294 const char *prefix_name,
296 Xapian::PostingIterator *begin,
297 Xapian::PostingIterator *end)
301 term = talloc_asprintf (notmuch, "%s%s",
302 _find_prefix (prefix_name), value);
304 find_doc_ids_for_term (notmuch, term, begin, end);
309 notmuch_private_status_t
310 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
311 const char *prefix_name,
313 unsigned int *doc_id)
315 Xapian::PostingIterator i, end;
317 find_doc_ids (notmuch, prefix_name, value, &i, &end);
321 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
326 #if DEBUG_DATABASE_SANITY
330 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
334 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
337 static Xapian::Document
338 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
340 return notmuch->xapian_db->get_document (doc_id);
343 /* Generate a compressed version of 'message_id' of the form:
345 * notmuch-sha1-<sha1_sum_of_message_id>
348 _message_id_compressed (void *ctx, const char *message_id)
350 char *sha1, *compressed;
352 sha1 = notmuch_sha1_of_string (message_id);
354 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
361 notmuch_database_find_message (notmuch_database_t *notmuch,
362 const char *message_id,
363 notmuch_message_t **message_ret)
365 notmuch_private_status_t status;
368 if (message_ret == NULL)
369 return NOTMUCH_STATUS_NULL_POINTER;
371 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
372 message_id = _message_id_compressed (notmuch, message_id);
375 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
376 message_id, &doc_id);
378 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
381 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
383 if (*message_ret == NULL)
384 return NOTMUCH_STATUS_OUT_OF_MEMORY;
387 return NOTMUCH_STATUS_SUCCESS;
388 } catch (const Xapian::Error &error) {
389 fprintf (stderr, "A Xapian exception occurred finding message: %s.\n",
390 error.get_msg().c_str());
391 notmuch->exception_reported = TRUE;
393 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
397 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
398 * a (potentially nested) parenthesized sequence with '\' used to
399 * escape any character (including parentheses).
401 * If the sequence to be skipped continues to the end of the string,
402 * then 'str' will be left pointing at the final terminating '\0'
406 skip_space_and_comments (const char **str)
411 while (*s && (isspace (*s) || *s == '(')) {
412 while (*s && isspace (*s))
417 while (*s && nesting) {
420 } else if (*s == ')') {
422 } else if (*s == '\\') {
434 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
435 * comments, and the '<' and '>' delimiters.
437 * If not NULL, then *next will be made to point to the first character
438 * not parsed, (possibly pointing to the final '\0' terminator.
440 * Returns a newly talloc'ed string belonging to 'ctx'.
442 * Returns NULL if there is any error parsing the message-id. */
444 _parse_message_id (void *ctx, const char *message_id, const char **next)
449 if (message_id == NULL || *message_id == '\0')
454 skip_space_and_comments (&s);
456 /* Skip any unstructured text as well. */
457 while (*s && *s != '<')
468 skip_space_and_comments (&s);
471 while (*end && *end != '>')
480 if (end > s && *end == '>')
485 result = talloc_strndup (ctx, s, end - s + 1);
487 /* Finally, collapse any whitespace that is within the message-id
493 for (r = result, len = strlen (r); *r; r++, len--)
494 if (*r == ' ' || *r == '\t')
495 memmove (r, r+1, len);
501 /* Parse a References header value, putting a (talloc'ed under 'ctx')
502 * copy of each referenced message-id into 'hash'.
504 * We explicitly avoid including any reference identical to
505 * 'message_id' in the result (to avoid mass confusion when a single
506 * message references itself cyclically---and yes, mail messages are
507 * not infrequent in the wild that do this---don't ask me why).
509 * Return the last reference parsed, if it is not equal to message_id.
512 parse_references (void *ctx,
513 const char *message_id,
519 if (refs == NULL || *refs == '\0')
523 ref = _parse_message_id (ctx, refs, &refs);
525 if (ref && strcmp (ref, message_id))
526 g_hash_table_insert (hash, ref, NULL);
529 /* The return value of this function is used to add a parent
530 * reference to the database. We should avoid making a message
531 * its own parent, thus the following check.
534 if (ref && strcmp(ref, message_id)) {
542 notmuch_database_create (const char *path, notmuch_database_t **database)
544 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
545 notmuch_database_t *notmuch = NULL;
546 char *notmuch_path = NULL;
551 fprintf (stderr, "Error: Cannot create a database for a NULL path.\n");
552 status = NOTMUCH_STATUS_NULL_POINTER;
556 err = stat (path, &st);
558 fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
559 path, strerror (errno));
560 status = NOTMUCH_STATUS_FILE_ERROR;
564 if (! S_ISDIR (st.st_mode)) {
565 fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
567 status = NOTMUCH_STATUS_FILE_ERROR;
571 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
573 err = mkdir (notmuch_path, 0755);
576 fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
577 notmuch_path, strerror (errno));
578 status = NOTMUCH_STATUS_FILE_ERROR;
582 status = notmuch_database_open (path,
583 NOTMUCH_DATABASE_MODE_READ_WRITE,
587 status = notmuch_database_upgrade (notmuch, NULL, NULL);
589 notmuch_database_close(notmuch);
595 talloc_free (notmuch_path);
600 talloc_free (notmuch);
605 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
607 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
608 fprintf (stderr, "Cannot write to a read-only database.\n");
609 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
612 return NOTMUCH_STATUS_SUCCESS;
616 notmuch_database_open (const char *path,
617 notmuch_database_mode_t mode,
618 notmuch_database_t **database)
620 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
621 void *local = talloc_new (NULL);
622 notmuch_database_t *notmuch = NULL;
623 char *notmuch_path, *xapian_path;
626 unsigned int i, version;
627 static int initialized = 0;
630 fprintf (stderr, "Error: Cannot open a database for a NULL path.\n");
631 status = NOTMUCH_STATUS_NULL_POINTER;
635 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
636 fprintf (stderr, "Out of memory\n");
637 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
641 err = stat (notmuch_path, &st);
643 fprintf (stderr, "Error opening database at %s: %s\n",
644 notmuch_path, strerror (errno));
645 status = NOTMUCH_STATUS_FILE_ERROR;
649 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
650 fprintf (stderr, "Out of memory\n");
651 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
655 /* Initialize the GLib type system and threads */
656 #if !GLIB_CHECK_VERSION(2, 35, 1)
660 /* Initialize gmime */
662 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
666 notmuch = talloc_zero (NULL, notmuch_database_t);
667 notmuch->exception_reported = FALSE;
668 notmuch->path = talloc_strdup (notmuch, path);
670 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
671 notmuch->path[strlen (notmuch->path) - 1] = '\0';
673 notmuch->needs_upgrade = FALSE;
674 notmuch->mode = mode;
675 notmuch->atomic_nesting = 0;
677 string last_thread_id;
679 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
680 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
681 Xapian::DB_CREATE_OR_OPEN);
682 version = notmuch_database_get_version (notmuch);
684 if (version > NOTMUCH_DATABASE_VERSION) {
686 "Error: Notmuch database at %s\n"
687 " has a newer database format version (%u) than supported by this\n"
688 " version of notmuch (%u). Refusing to open this database in\n"
689 " read-write mode.\n",
690 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
691 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
692 notmuch_database_destroy (notmuch);
694 status = NOTMUCH_STATUS_FILE_ERROR;
698 if (version < NOTMUCH_DATABASE_VERSION)
699 notmuch->needs_upgrade = TRUE;
701 notmuch->xapian_db = new Xapian::Database (xapian_path);
702 version = notmuch_database_get_version (notmuch);
703 if (version > NOTMUCH_DATABASE_VERSION)
706 "Warning: Notmuch database at %s\n"
707 " has a newer database format version (%u) than supported by this\n"
708 " version of notmuch (%u). Some operations may behave incorrectly,\n"
709 " (but the database will not be harmed since it is being opened\n"
710 " in read-only mode).\n",
711 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
715 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
716 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
717 if (last_thread_id.empty ()) {
718 notmuch->last_thread_id = 0;
723 str = last_thread_id.c_str ();
724 notmuch->last_thread_id = strtoull (str, &end, 16);
726 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
729 notmuch->query_parser = new Xapian::QueryParser;
730 notmuch->term_gen = new Xapian::TermGenerator;
731 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
732 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
733 notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
735 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
736 notmuch->query_parser->set_database (*notmuch->xapian_db);
737 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
738 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
739 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
740 notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
742 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
743 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
744 notmuch->query_parser->add_boolean_prefix (prefix->name,
748 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
749 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
750 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
752 } catch (const Xapian::Error &error) {
753 fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
754 error.get_msg().c_str());
755 notmuch_database_destroy (notmuch);
757 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
766 talloc_free (notmuch);
771 notmuch_database_close (notmuch_database_t *notmuch)
774 if (notmuch->xapian_db != NULL &&
775 notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
776 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
777 } catch (const Xapian::Error &error) {
778 if (! notmuch->exception_reported) {
779 fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
780 error.get_msg().c_str());
784 /* Many Xapian objects (and thus notmuch objects) hold references to
785 * the database, so merely deleting the database may not suffice to
786 * close it. Thus, we explicitly close it here. */
787 if (notmuch->xapian_db != NULL) {
789 notmuch->xapian_db->close();
790 } catch (const Xapian::Error &error) {
795 delete notmuch->term_gen;
796 notmuch->term_gen = NULL;
797 delete notmuch->query_parser;
798 notmuch->query_parser = NULL;
799 delete notmuch->xapian_db;
800 notmuch->xapian_db = NULL;
801 delete notmuch->value_range_processor;
802 notmuch->value_range_processor = NULL;
803 delete notmuch->date_range_processor;
804 notmuch->date_range_processor = NULL;
807 #if HAVE_XAPIAN_COMPACT
809 unlink_cb (const char *path,
810 unused (const struct stat *sb),
812 unused (struct FTW *ftw))
814 return remove (path);
818 rmtree (const char *path)
820 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
823 class NotmuchCompactor : public Xapian::Compactor
825 notmuch_compact_status_cb_t status_cb;
826 void *status_closure;
829 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
830 status_cb (cb), status_closure (closure) { }
833 set_status (const std::string &table, const std::string &status)
837 if (status_cb == NULL)
840 if (status.length () == 0)
841 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
843 msg = talloc_asprintf (NULL, " %s", status.c_str());
849 status_cb (msg, status_closure);
854 /* Compacts the given database, optionally saving the original database
855 * in backup_path. Additionally, a callback function can be provided to
856 * give the user feedback on the progress of the (likely long-lived)
857 * compaction process.
859 * The backup path must point to a directory on the same volume as the
860 * original database. Passing a NULL backup_path will result in the
861 * uncompacted database being deleted after compaction has finished.
862 * Note that the database write lock will be held during the
863 * compaction process to protect data integrity.
866 notmuch_database_compact (const char *path,
867 const char *backup_path,
868 notmuch_compact_status_cb_t status_cb,
872 char *notmuch_path, *xapian_path, *compact_xapian_path;
873 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
874 notmuch_database_t *notmuch = NULL;
877 local = talloc_new (NULL);
879 return NOTMUCH_STATUS_OUT_OF_MEMORY;
881 ret = notmuch_database_open (path, NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much);
886 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
887 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
891 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
892 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
896 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
897 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
901 if (backup_path != NULL) {
902 if (stat (backup_path, &statbuf) != -1) {
903 fprintf (stderr, "Backup path already exists: %s\n", backup_path);
904 ret = NOTMUCH_STATUS_FILE_ERROR;
907 if (errno != ENOENT) {
908 fprintf (stderr, "Unknown error while stat()ing backup path: %s\n",
915 NotmuchCompactor compactor (status_cb, closure);
917 compactor.set_renumber (false);
918 compactor.add_source (xapian_path);
919 compactor.set_destdir (compact_xapian_path);
920 compactor.compact ();
921 } catch (const Xapian::Error &error) {
922 fprintf (stderr, "Error while compacting: %s\n", error.get_msg().c_str());
923 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
928 if (rename (xapian_path, backup_path)) {
929 fprintf (stderr, "Error moving old database out of the way\n");
930 ret = NOTMUCH_STATUS_FILE_ERROR;
934 rmtree (xapian_path);
937 if (rename (compact_xapian_path, xapian_path)) {
938 fprintf (stderr, "Error moving compacted database\n");
939 ret = NOTMUCH_STATUS_FILE_ERROR;
945 notmuch_database_destroy (notmuch);
953 notmuch_database_compact (unused (const char *path),
954 unused (const char *backup_path),
955 unused (notmuch_compact_status_cb_t status_cb),
956 unused (void *closure))
958 fprintf (stderr, "notmuch was compiled against a xapian version lacking compaction support.\n");
959 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
964 notmuch_database_destroy (notmuch_database_t *notmuch)
966 notmuch_database_close (notmuch);
967 talloc_free (notmuch);
971 notmuch_database_get_path (notmuch_database_t *notmuch)
973 return notmuch->path;
977 notmuch_database_get_version (notmuch_database_t *notmuch)
979 unsigned int version;
980 string version_string;
984 version_string = notmuch->xapian_db->get_metadata ("version");
985 if (version_string.empty ())
988 str = version_string.c_str ();
989 if (str == NULL || *str == '\0')
992 version = strtoul (str, &end, 10);
994 INTERNAL_ERROR ("Malformed database version: %s", str);
1000 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1002 return notmuch->needs_upgrade;
1005 static volatile sig_atomic_t do_progress_notify = 0;
1008 handle_sigalrm (unused (int signal))
1010 do_progress_notify = 1;
1013 /* Upgrade the current database.
1015 * After opening a database in read-write mode, the client should
1016 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1017 * if so, upgrade with this function before making any modifications.
1019 * The optional progress_notify callback can be used by the caller to
1020 * provide progress indication to the user. If non-NULL it will be
1021 * called periodically with 'count' as the number of messages upgraded
1022 * so far and 'total' the overall number of messages that will be
1026 notmuch_database_upgrade (notmuch_database_t *notmuch,
1027 void (*progress_notify) (void *closure,
1031 Xapian::WritableDatabase *db;
1032 struct sigaction action;
1033 struct itimerval timerval;
1034 notmuch_bool_t timer_is_active = FALSE;
1035 unsigned int version;
1036 notmuch_status_t status;
1037 unsigned int count = 0, total = 0;
1039 status = _notmuch_database_ensure_writable (notmuch);
1043 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1045 version = notmuch_database_get_version (notmuch);
1047 if (version >= NOTMUCH_DATABASE_VERSION)
1048 return NOTMUCH_STATUS_SUCCESS;
1050 if (progress_notify) {
1051 /* Setup our handler for SIGALRM */
1052 memset (&action, 0, sizeof (struct sigaction));
1053 action.sa_handler = handle_sigalrm;
1054 sigemptyset (&action.sa_mask);
1055 action.sa_flags = SA_RESTART;
1056 sigaction (SIGALRM, &action, NULL);
1058 /* Then start a timer to send SIGALRM once per second. */
1059 timerval.it_interval.tv_sec = 1;
1060 timerval.it_interval.tv_usec = 0;
1061 timerval.it_value.tv_sec = 1;
1062 timerval.it_value.tv_usec = 0;
1063 setitimer (ITIMER_REAL, &timerval, NULL);
1065 timer_is_active = TRUE;
1068 /* Before version 1, each message document had its filename in the
1069 * data field. Copy that into the new format by calling
1070 * notmuch_message_add_filename.
1073 notmuch_query_t *query = notmuch_query_create (notmuch, "");
1074 notmuch_messages_t *messages;
1075 notmuch_message_t *message;
1077 Xapian::TermIterator t, t_end;
1079 total = notmuch_query_count_messages (query);
1081 for (messages = notmuch_query_search_messages (query);
1082 notmuch_messages_valid (messages);
1083 notmuch_messages_move_to_next (messages))
1085 if (do_progress_notify) {
1086 progress_notify (closure, (double) count / total);
1087 do_progress_notify = 0;
1090 message = notmuch_messages_get (messages);
1092 filename = _notmuch_message_talloc_copy_data (message);
1093 if (filename && *filename != '\0') {
1094 _notmuch_message_add_filename (message, filename);
1095 _notmuch_message_sync (message);
1097 talloc_free (filename);
1099 notmuch_message_destroy (message);
1104 notmuch_query_destroy (query);
1106 /* Also, before version 1 we stored directory timestamps in
1107 * XTIMESTAMP documents instead of the current XDIRECTORY
1108 * documents. So copy those as well. */
1110 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1112 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1116 Xapian::PostingIterator p, p_end;
1117 std::string term = *t;
1119 p_end = notmuch->xapian_db->postlist_end (term);
1121 for (p = notmuch->xapian_db->postlist_begin (term);
1125 Xapian::Document document;
1127 notmuch_directory_t *directory;
1129 if (do_progress_notify) {
1130 progress_notify (closure, (double) count / total);
1131 do_progress_notify = 0;
1134 document = find_document_for_doc_id (notmuch, *p);
1135 mtime = Xapian::sortable_unserialise (
1136 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1138 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1139 NOTMUCH_FIND_CREATE, &status);
1140 notmuch_directory_set_mtime (directory, mtime);
1141 notmuch_directory_destroy (directory);
1146 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1149 /* Now that the upgrade is complete we can remove the old data
1150 * and documents that are no longer needed. */
1152 notmuch_query_t *query = notmuch_query_create (notmuch, "");
1153 notmuch_messages_t *messages;
1154 notmuch_message_t *message;
1157 for (messages = notmuch_query_search_messages (query);
1158 notmuch_messages_valid (messages);
1159 notmuch_messages_move_to_next (messages))
1161 if (do_progress_notify) {
1162 progress_notify (closure, (double) count / total);
1163 do_progress_notify = 0;
1166 message = notmuch_messages_get (messages);
1168 filename = _notmuch_message_talloc_copy_data (message);
1169 if (filename && *filename != '\0') {
1170 _notmuch_message_clear_data (message);
1171 _notmuch_message_sync (message);
1173 talloc_free (filename);
1175 notmuch_message_destroy (message);
1178 notmuch_query_destroy (query);
1182 Xapian::TermIterator t, t_end;
1184 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1186 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1190 Xapian::PostingIterator p, p_end;
1191 std::string term = *t;
1193 p_end = notmuch->xapian_db->postlist_end (term);
1195 for (p = notmuch->xapian_db->postlist_begin (term);
1199 if (do_progress_notify) {
1200 progress_notify (closure, (double) count / total);
1201 do_progress_notify = 0;
1204 db->delete_document (*p);
1209 if (timer_is_active) {
1210 /* Now stop the timer. */
1211 timerval.it_interval.tv_sec = 0;
1212 timerval.it_interval.tv_usec = 0;
1213 timerval.it_value.tv_sec = 0;
1214 timerval.it_value.tv_usec = 0;
1215 setitimer (ITIMER_REAL, &timerval, NULL);
1217 /* And disable the signal handler. */
1218 action.sa_handler = SIG_IGN;
1219 sigaction (SIGALRM, &action, NULL);
1222 return NOTMUCH_STATUS_SUCCESS;
1226 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1228 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1229 notmuch->atomic_nesting > 0)
1233 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1234 } catch (const Xapian::Error &error) {
1235 fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
1236 error.get_msg().c_str());
1237 notmuch->exception_reported = TRUE;
1238 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1242 notmuch->atomic_nesting++;
1243 return NOTMUCH_STATUS_SUCCESS;
1247 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1249 Xapian::WritableDatabase *db;
1251 if (notmuch->atomic_nesting == 0)
1252 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1254 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1255 notmuch->atomic_nesting > 1)
1258 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1260 db->commit_transaction ();
1262 /* This is a hack for testing. Xapian never flushes on a
1263 * non-flushed commit, even if the flush threshold is 1.
1264 * However, we rely on flushing to test atomicity. */
1265 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1266 if (thresh && atoi (thresh) == 1)
1268 } catch (const Xapian::Error &error) {
1269 fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1270 error.get_msg().c_str());
1271 notmuch->exception_reported = TRUE;
1272 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1276 notmuch->atomic_nesting--;
1277 return NOTMUCH_STATUS_SUCCESS;
1280 /* We allow the user to use arbitrarily long paths for directories. But
1281 * we have a term-length limit. So if we exceed that, we'll use the
1282 * SHA-1 of the path for the database term.
1284 * Note: This function may return the original value of 'path'. If it
1285 * does not, then the caller is responsible to free() the returned
1289 _notmuch_database_get_directory_db_path (const char *path)
1291 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1293 if (term_len > NOTMUCH_TERM_MAX)
1294 return notmuch_sha1_of_string (path);
1299 /* Given a path, split it into two parts: the directory part is all
1300 * components except for the last, and the basename is that last
1301 * component. Getting the return-value for either part is optional
1302 * (the caller can pass NULL).
1304 * The original 'path' can represent either a regular file or a
1305 * directory---the splitting will be carried out in the same way in
1306 * either case. Trailing slashes on 'path' will be ignored, and any
1307 * cases of multiple '/' characters appearing in series will be
1308 * treated as a single '/'.
1310 * Allocation (if any) will have 'ctx' as the talloc owner. But
1311 * pointers will be returned within the original path string whenever
1314 * Note: If 'path' is non-empty and contains no non-trailing slash,
1315 * (that is, consists of a filename with no parent directory), then
1316 * the directory returned will be an empty string. However, if 'path'
1317 * is an empty string, then both directory and basename will be
1321 _notmuch_database_split_path (void *ctx,
1323 const char **directory,
1324 const char **basename)
1328 if (path == NULL || *path == '\0') {
1333 return NOTMUCH_STATUS_SUCCESS;
1336 /* Find the last slash (not counting a trailing slash), if any. */
1338 slash = path + strlen (path) - 1;
1340 /* First, skip trailing slashes. */
1341 while (slash != path) {
1348 /* Then, find a slash. */
1349 while (slash != path) {
1359 /* Finally, skip multiple slashes. */
1360 while (slash != path) {
1367 if (slash == path) {
1369 *directory = talloc_strdup (ctx, "");
1374 *directory = talloc_strndup (ctx, path, slash - path + 1);
1377 return NOTMUCH_STATUS_SUCCESS;
1380 /* Find the document ID of the specified directory.
1382 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1383 * created if one does not exist for 'path'. Otherwise, if the
1384 * directory document does not exist, this sets *directory_id to
1385 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1388 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1390 notmuch_find_flags_t flags,
1391 unsigned int *directory_id)
1393 notmuch_directory_t *directory;
1394 notmuch_status_t status;
1398 return NOTMUCH_STATUS_SUCCESS;
1401 directory = _notmuch_directory_create (notmuch, path, flags, &status);
1402 if (status || !directory) {
1407 *directory_id = _notmuch_directory_get_document_id (directory);
1409 notmuch_directory_destroy (directory);
1411 return NOTMUCH_STATUS_SUCCESS;
1415 _notmuch_database_get_directory_path (void *ctx,
1416 notmuch_database_t *notmuch,
1417 unsigned int doc_id)
1419 Xapian::Document document;
1421 document = find_document_for_doc_id (notmuch, doc_id);
1423 return talloc_strdup (ctx, document.get_data ().c_str ());
1426 /* Given a legal 'filename' for the database, (either relative to
1427 * database path or absolute with initial components identical to
1428 * database path), return a new string (with 'ctx' as the talloc
1429 * owner) suitable for use as a direntry term value.
1431 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1432 * will be created in the database as needed. Otherwise, if the
1433 * necessary directory documents do not exist, this sets
1434 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1437 _notmuch_database_filename_to_direntry (void *ctx,
1438 notmuch_database_t *notmuch,
1439 const char *filename,
1440 notmuch_find_flags_t flags,
1443 const char *relative, *directory, *basename;
1444 Xapian::docid directory_id;
1445 notmuch_status_t status;
1447 relative = _notmuch_database_relative_path (notmuch, filename);
1449 status = _notmuch_database_split_path (ctx, relative,
1450 &directory, &basename);
1454 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1456 if (status || directory_id == (unsigned int)-1) {
1461 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1463 return NOTMUCH_STATUS_SUCCESS;
1466 /* Given a legal 'path' for the database, return the relative path.
1468 * The return value will be a pointer to the original path contents,
1469 * and will be either the original string (if 'path' was relative) or
1470 * a portion of the string (if path was absolute and begins with the
1474 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1477 const char *db_path, *relative;
1478 unsigned int db_path_len;
1480 db_path = notmuch_database_get_path (notmuch);
1481 db_path_len = strlen (db_path);
1485 if (*relative == '/') {
1486 while (*relative == '/' && *(relative+1) == '/')
1489 if (strncmp (relative, db_path, db_path_len) == 0)
1491 relative += db_path_len;
1492 while (*relative == '/')
1501 notmuch_database_get_directory (notmuch_database_t *notmuch,
1503 notmuch_directory_t **directory)
1505 notmuch_status_t status;
1507 if (directory == NULL)
1508 return NOTMUCH_STATUS_NULL_POINTER;
1512 *directory = _notmuch_directory_create (notmuch, path,
1513 NOTMUCH_FIND_LOOKUP, &status);
1514 } catch (const Xapian::Error &error) {
1515 fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1516 error.get_msg().c_str());
1517 notmuch->exception_reported = TRUE;
1518 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1523 /* Allocate a document ID that satisfies the following criteria:
1525 * 1. The ID does not exist for any document in the Xapian database
1527 * 2. The ID was not previously returned from this function
1529 * 3. The ID is the smallest integer satisfying (1) and (2)
1531 * This function will trigger an internal error if these constraints
1532 * cannot all be satisfied, (that is, the pool of available document
1533 * IDs has been exhausted).
1536 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1538 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1540 notmuch->last_doc_id++;
1542 if (notmuch->last_doc_id == 0)
1543 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1545 return notmuch->last_doc_id;
1549 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1551 /* 16 bytes (+ terminator) for hexadecimal representation of
1552 * a 64-bit integer. */
1553 static char thread_id[17];
1554 Xapian::WritableDatabase *db;
1556 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1558 notmuch->last_thread_id++;
1560 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1562 db->set_metadata ("last_thread_id", thread_id);
1568 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1570 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1571 message_id = _message_id_compressed (ctx, message_id);
1573 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1577 /* Find the thread ID to which the message with 'message_id' belongs.
1579 * Note: 'thread_id_ret' must not be NULL!
1580 * On success '*thread_id_ret' is set to a newly talloced string belonging to
1583 * Note: If there is no message in the database with the given
1584 * 'message_id' then a new thread_id will be allocated for this
1585 * message and stored in the database metadata, (where this same
1586 * thread ID can be looked up if the message is added to the database
1589 static notmuch_status_t
1590 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1592 const char *message_id,
1593 const char **thread_id_ret)
1595 notmuch_status_t status;
1596 notmuch_message_t *message;
1597 string thread_id_string;
1599 Xapian::WritableDatabase *db;
1601 status = notmuch_database_find_message (notmuch, message_id, &message);
1607 *thread_id_ret = talloc_steal (ctx,
1608 notmuch_message_get_thread_id (message));
1610 notmuch_message_destroy (message);
1612 return NOTMUCH_STATUS_SUCCESS;
1615 /* Message has not been seen yet.
1617 * We may have seen a reference to it already, in which case, we
1618 * can return the thread ID stored in the metadata. Otherwise, we
1619 * generate a new thread ID and store it there.
1621 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1622 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1623 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1625 if (thread_id_string.empty()) {
1626 *thread_id_ret = talloc_strdup (ctx,
1627 _notmuch_database_generate_thread_id (notmuch));
1628 db->set_metadata (metadata_key, *thread_id_ret);
1630 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1633 talloc_free (metadata_key);
1635 return NOTMUCH_STATUS_SUCCESS;
1638 static notmuch_status_t
1639 _merge_threads (notmuch_database_t *notmuch,
1640 const char *winner_thread_id,
1641 const char *loser_thread_id)
1643 Xapian::PostingIterator loser, loser_end;
1644 notmuch_message_t *message = NULL;
1645 notmuch_private_status_t private_status;
1646 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1648 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1650 for ( ; loser != loser_end; loser++) {
1651 message = _notmuch_message_create (notmuch, notmuch,
1652 *loser, &private_status);
1653 if (message == NULL) {
1654 ret = COERCE_STATUS (private_status,
1655 "Cannot find document for doc_id from query");
1659 _notmuch_message_remove_term (message, "thread", loser_thread_id);
1660 _notmuch_message_add_term (message, "thread", winner_thread_id);
1661 _notmuch_message_sync (message);
1663 notmuch_message_destroy (message);
1669 notmuch_message_destroy (message);
1675 _my_talloc_free_for_g_hash (void *ptr)
1680 static notmuch_status_t
1681 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1682 notmuch_message_t *message,
1683 notmuch_message_file_t *message_file,
1684 const char **thread_id)
1686 GHashTable *parents = NULL;
1687 const char *refs, *in_reply_to, *in_reply_to_message_id;
1688 const char *last_ref_message_id, *this_message_id;
1689 GList *l, *keys = NULL;
1690 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1692 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1693 _my_talloc_free_for_g_hash, NULL);
1694 this_message_id = notmuch_message_get_message_id (message);
1696 refs = notmuch_message_file_get_header (message_file, "references");
1697 last_ref_message_id = parse_references (message,
1701 in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1702 in_reply_to_message_id = parse_references (message,
1704 parents, in_reply_to);
1706 /* For the parent of this message, use the last message ID of the
1707 * References header, if available. If not, fall back to the
1708 * first message ID in the In-Reply-To header. */
1709 if (last_ref_message_id) {
1710 _notmuch_message_add_term (message, "replyto",
1711 last_ref_message_id);
1712 } else if (in_reply_to_message_id) {
1713 _notmuch_message_add_term (message, "replyto",
1714 in_reply_to_message_id);
1717 keys = g_hash_table_get_keys (parents);
1718 for (l = keys; l; l = l->next) {
1719 char *parent_message_id;
1720 const char *parent_thread_id = NULL;
1722 parent_message_id = (char *) l->data;
1724 _notmuch_message_add_term (message, "reference",
1727 ret = _resolve_message_id_to_thread_id (notmuch,
1734 if (*thread_id == NULL) {
1735 *thread_id = talloc_strdup (message, parent_thread_id);
1736 _notmuch_message_add_term (message, "thread", *thread_id);
1737 } else if (strcmp (*thread_id, parent_thread_id)) {
1738 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1748 g_hash_table_unref (parents);
1753 static notmuch_status_t
1754 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1755 notmuch_message_t *message,
1756 const char **thread_id)
1758 const char *message_id = notmuch_message_get_message_id (message);
1759 Xapian::PostingIterator child, children_end;
1760 notmuch_message_t *child_message = NULL;
1761 const char *child_thread_id;
1762 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1763 notmuch_private_status_t private_status;
1765 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1767 for ( ; child != children_end; child++) {
1769 child_message = _notmuch_message_create (message, notmuch,
1770 *child, &private_status);
1771 if (child_message == NULL) {
1772 ret = COERCE_STATUS (private_status,
1773 "Cannot find document for doc_id from query");
1777 child_thread_id = notmuch_message_get_thread_id (child_message);
1778 if (*thread_id == NULL) {
1779 *thread_id = talloc_strdup (message, child_thread_id);
1780 _notmuch_message_add_term (message, "thread", *thread_id);
1781 } else if (strcmp (*thread_id, child_thread_id)) {
1782 _notmuch_message_remove_term (child_message, "reference",
1784 _notmuch_message_sync (child_message);
1785 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1790 notmuch_message_destroy (child_message);
1791 child_message = NULL;
1796 notmuch_message_destroy (child_message);
1801 /* Given a (mostly empty) 'message' and its corresponding
1802 * 'message_file' link it to existing threads in the database.
1804 * The first check is in the metadata of the database to see if we
1805 * have pre-allocated a thread_id in advance for this message, (which
1806 * would have happened if a message was previously added that
1807 * referenced this one).
1809 * Second, we look at 'message_file' and its link-relevant headers
1810 * (References and In-Reply-To) for message IDs.
1812 * Finally, we look in the database for existing message that
1813 * reference 'message'.
1815 * In all cases, we assign to the current message the first thread_id
1816 * found (through either parent or child). We will also merge any
1817 * existing, distinct threads where this message belongs to both,
1818 * (which is not uncommon when messages are processed out of order).
1820 * Finally, if no thread ID has been found through parent or child, we
1821 * call _notmuch_message_generate_thread_id to generate a new thread
1822 * ID. This should only happen for new, top-level messages, (no
1823 * References or In-Reply-To header in this message, and no previously
1824 * added message refers to this message).
1826 static notmuch_status_t
1827 _notmuch_database_link_message (notmuch_database_t *notmuch,
1828 notmuch_message_t *message,
1829 notmuch_message_file_t *message_file)
1831 notmuch_status_t status;
1832 const char *message_id, *thread_id = NULL;
1836 message_id = notmuch_message_get_message_id (message);
1837 metadata_key = _get_metadata_thread_id_key (message, message_id);
1839 /* Check if we have already seen related messages to this one.
1840 * If we have then use the thread_id that we stored at that time.
1842 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1843 if (! stored_id.empty()) {
1844 Xapian::WritableDatabase *db;
1846 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1848 /* Clear the metadata for this message ID. We don't need it
1850 db->set_metadata (metadata_key, "");
1851 thread_id = stored_id.c_str();
1853 _notmuch_message_add_term (message, "thread", thread_id);
1855 talloc_free (metadata_key);
1857 status = _notmuch_database_link_message_to_parents (notmuch, message,
1863 status = _notmuch_database_link_message_to_children (notmuch, message,
1868 /* If not part of any existing thread, generate a new thread ID. */
1869 if (thread_id == NULL) {
1870 thread_id = _notmuch_database_generate_thread_id (notmuch);
1872 _notmuch_message_add_term (message, "thread", thread_id);
1875 return NOTMUCH_STATUS_SUCCESS;
1879 notmuch_database_add_message (notmuch_database_t *notmuch,
1880 const char *filename,
1881 notmuch_message_t **message_ret)
1883 notmuch_message_file_t *message_file;
1884 notmuch_message_t *message = NULL;
1885 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1886 notmuch_private_status_t private_status;
1888 const char *date, *header;
1889 const char *from, *to, *subject;
1890 char *message_id = NULL;
1893 *message_ret = NULL;
1895 ret = _notmuch_database_ensure_writable (notmuch);
1899 message_file = notmuch_message_file_open (filename);
1900 if (message_file == NULL)
1901 return NOTMUCH_STATUS_FILE_ERROR;
1903 /* Adding a message may change many documents. Do this all
1905 ret = notmuch_database_begin_atomic (notmuch);
1909 notmuch_message_file_restrict_headers (message_file,
1920 /* Before we do any real work, (especially before doing a
1921 * potential SHA-1 computation on the entire file's contents),
1922 * let's make sure that what we're looking at looks like an
1923 * actual email message.
1925 from = notmuch_message_file_get_header (message_file, "from");
1926 subject = notmuch_message_file_get_header (message_file, "subject");
1927 to = notmuch_message_file_get_header (message_file, "to");
1929 if ((from == NULL || *from == '\0') &&
1930 (subject == NULL || *subject == '\0') &&
1931 (to == NULL || *to == '\0'))
1933 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1937 /* Now that we're sure it's mail, the first order of business
1938 * is to find a message ID (or else create one ourselves). */
1940 header = notmuch_message_file_get_header (message_file, "message-id");
1941 if (header && *header != '\0') {
1942 message_id = _parse_message_id (message_file, header, NULL);
1944 /* So the header value isn't RFC-compliant, but it's
1945 * better than no message-id at all. */
1946 if (message_id == NULL)
1947 message_id = talloc_strdup (message_file, header);
1949 /* If a message ID is too long, substitute its sha1 instead. */
1950 if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1951 char *compressed = _message_id_compressed (message_file,
1953 talloc_free (message_id);
1954 message_id = compressed;
1958 if (message_id == NULL ) {
1959 /* No message-id at all, let's generate one by taking a
1960 * hash over the file's contents. */
1961 char *sha1 = notmuch_sha1_of_file (filename);
1963 /* If that failed too, something is really wrong. Give up. */
1965 ret = NOTMUCH_STATUS_FILE_ERROR;
1969 message_id = talloc_asprintf (message_file,
1970 "notmuch-sha1-%s", sha1);
1974 /* Now that we have a message ID, we get a message object,
1975 * (which may or may not reference an existing document in the
1978 message = _notmuch_message_create_for_message_id (notmuch,
1982 talloc_free (message_id);
1984 if (message == NULL) {
1985 ret = COERCE_STATUS (private_status,
1986 "Unexpected status value from _notmuch_message_create_for_message_id");
1990 _notmuch_message_add_filename (message, filename);
1992 /* Is this a newly created message object? */
1993 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1994 _notmuch_message_add_term (message, "type", "mail");
1996 ret = _notmuch_database_link_message (notmuch, message,
2001 date = notmuch_message_file_get_header (message_file, "date");
2002 _notmuch_message_set_header_values (message, date, from, subject);
2004 ret = _notmuch_message_index_file (message, filename);
2008 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2011 _notmuch_message_sync (message);
2012 } catch (const Xapian::Error &error) {
2013 fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
2014 error.get_msg().c_str());
2015 notmuch->exception_reported = TRUE;
2016 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2022 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2023 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2024 *message_ret = message;
2026 notmuch_message_destroy (message);
2030 notmuch_message_file_close (message_file);
2032 ret2 = notmuch_database_end_atomic (notmuch);
2033 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2034 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2035 ret2 != NOTMUCH_STATUS_SUCCESS)
2042 notmuch_database_remove_message (notmuch_database_t *notmuch,
2043 const char *filename)
2045 notmuch_status_t status;
2046 notmuch_message_t *message;
2048 status = notmuch_database_find_message_by_filename (notmuch, filename,
2051 if (status == NOTMUCH_STATUS_SUCCESS && message) {
2052 status = _notmuch_message_remove_filename (message, filename);
2053 if (status == NOTMUCH_STATUS_SUCCESS)
2054 _notmuch_message_delete (message);
2055 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2056 _notmuch_message_sync (message);
2058 notmuch_message_destroy (message);
2065 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2066 const char *filename,
2067 notmuch_message_t **message_ret)
2070 const char *prefix = _find_prefix ("file-direntry");
2071 char *direntry, *term;
2072 Xapian::PostingIterator i, end;
2073 notmuch_status_t status;
2075 if (message_ret == NULL)
2076 return NOTMUCH_STATUS_NULL_POINTER;
2078 /* return NULL on any failure */
2079 *message_ret = NULL;
2081 local = talloc_new (notmuch);
2084 status = _notmuch_database_filename_to_direntry (
2085 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2086 if (status || !direntry)
2089 term = talloc_asprintf (local, "%s%s", prefix, direntry);
2091 find_doc_ids_for_term (notmuch, term, &i, &end);
2094 notmuch_private_status_t private_status;
2096 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2098 if (*message_ret == NULL)
2099 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2101 } catch (const Xapian::Error &error) {
2102 fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
2103 error.get_msg().c_str());
2104 notmuch->exception_reported = TRUE;
2105 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2109 talloc_free (local);
2111 if (status && *message_ret) {
2112 notmuch_message_destroy (*message_ret);
2113 *message_ret = NULL;
2118 notmuch_string_list_t *
2119 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2120 Xapian::TermIterator &end,
2123 int prefix_len = strlen (prefix);
2124 notmuch_string_list_t *list;
2126 list = _notmuch_string_list_create (ctx);
2127 if (unlikely (list == NULL))
2130 for (i.skip_to (prefix); i != end; i++) {
2131 /* Terminate loop at first term without desired prefix. */
2132 if (strncmp ((*i).c_str (), prefix, prefix_len))
2135 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2142 notmuch_database_get_all_tags (notmuch_database_t *db)
2144 Xapian::TermIterator i, end;
2145 notmuch_string_list_t *tags;
2148 i = db->xapian_db->allterms_begin();
2149 end = db->xapian_db->allterms_end();
2150 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2151 _find_prefix ("tag"));
2152 _notmuch_string_list_sort (tags);
2153 return _notmuch_tags_create (db, tags);
2154 } catch (const Xapian::Error &error) {
2155 fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
2156 error.get_msg().c_str());
2157 db->exception_reported = TRUE;