/* Here's the current schema for our database:
*
- * We currently have two different types of documents: mail and timestamps.
+ * We currently have two different types of documents: mail and directory.
*
* Mail document
* -------------
*
* tag: Any tags associated with this message by the user.
*
+ * file-direntry: A colon-separated pair of values
+ * (INTEGER:STRING), where INTEGER is the
+ * document ID of a directory document, and
+ * STRING is the name of a file within that
+ * directory for this mail message.
+ *
* A mail document also has two values:
*
* TIMESTAMP: The time_t value corresponding to the message's
* user in searching. But the database doesn't really care itself
* about any of these.
*
- * Timestamp document
+ * The data portion of a mail document is empty.
+ *
+ * Directory document
* ------------------
- * A timestamp document is used by a client of the notmuch library to
+ * A directory document is used by a client of the notmuch library to
* maintain data necessary to allow for efficient polling of mail
- * directories. The notmuch library does no interpretation of
- * timestamps, but merely allows the user to store and retrieve
- * timestamps as name/value pairs.
+ * directories.
+ *
+ * All directory documents contain one term:
*
- * The timestamp document is indexed with a single prefixed term:
+ * directory: The directory path (relative to the database path)
+ * Or the SHA1 sum of the directory path (if the
+ * path itself is too long to fit in a Xapian
+ * term).
*
- * timestamp: The user's key value (likely a directory name)
+ * And all directory documents for directories other than top-level
+ * directories also contain the following term:
*
- * and has a single value:
+ * directory-direntry: A colon-separated pair of values
+ * (INTEGER:STRING), where INTEGER is the
+ * document ID of the parent directory
+ * document, and STRING is the name of this
+ * directory within that parent.
*
- * TIMESTAMP: The time_t value from the user.
+ * All directory documents have a single value:
+ *
+ * TIMESTAMP: The mtime of the directory (at last scan)
+ *
+ * The data portion of a directory document contains the path of the
+ * directory (relative to the database path).
*/
/* With these prefix values we follow the conventions published here:
*/
prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
- { "type", "T" },
- { "reference", "XREFERENCE" },
- { "replyto", "XREPLYTO" },
- { "timestamp", "XTIMESTAMP" },
+ { "type", "T" },
+ { "reference", "XREFERENCE" },
+ { "replyto", "XREPLYTO" },
+ { "directory", "XDIRECTORY" },
+ { "file-direntry", "XFDIRENTRY" },
+ { "directory-direntry", "XDDIRENTRY" },
};
prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
- { "thread", "G" },
- { "tag", "K" },
- { "id", "Q" }
+ { "thread", "G" },
+ { "tag", "K" },
+ { "id", "Q" }
};
prefix_t PROBABILISTIC_PREFIX[]= {
- { "from", "XFROM" },
- { "to", "XTO" },
- { "attachment", "XATTACHMENT" },
- { "subject", "XSUBJECT"}
+ { "from", "XFROM" },
+ { "to", "XTO" },
+ { "attachment", "XATTACHMENT" },
+ { "subject", "XSUBJECT"}
};
int
case NOTMUCH_STATUS_OUT_OF_MEMORY:
return "Out of memory";
case NOTMUCH_STATUS_READONLY_DATABASE:
- return "The database is read-only";
+ return "Attempt to write to a read-only database";
case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
return "A Xapian exception occurred";
case NOTMUCH_STATUS_FILE_ERROR:
}
}
+static void
+find_doc_ids_for_term (notmuch_database_t *notmuch,
+ const char *term,
+ Xapian::PostingIterator *begin,
+ Xapian::PostingIterator *end)
+{
+ *begin = notmuch->xapian_db->postlist_begin (term);
+
+ *end = notmuch->xapian_db->postlist_end (term);
+}
+
static void
find_doc_ids (notmuch_database_t *notmuch,
const char *prefix_name,
Xapian::PostingIterator *begin,
Xapian::PostingIterator *end)
{
- Xapian::PostingIterator i;
char *term;
term = talloc_asprintf (notmuch, "%s%s",
_find_prefix (prefix_name), value);
- *begin = notmuch->xapian_db->postlist_begin (term);
-
- *end = notmuch->xapian_db->postlist_end (term);
+ find_doc_ids_for_term (notmuch, term, begin, end);
talloc_free (term);
}
-static notmuch_private_status_t
-find_unique_doc_id (notmuch_database_t *notmuch,
- const char *prefix_name,
- const char *value,
- unsigned int *doc_id)
+notmuch_private_status_t
+_notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
+ const char *prefix_name,
+ const char *value,
+ unsigned int *doc_id)
{
Xapian::PostingIterator i, end;
if (i == end) {
*doc_id = 0;
return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
- } else {
- *doc_id = *i;
- return NOTMUCH_PRIVATE_STATUS_SUCCESS;
}
+
+ *doc_id = *i;
+
+#if DEBUG_DATABASE_SANITY
+ i++;
+
+ if (i != end)
+ INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
+ prefix_name, value);
+#endif
+
+ return NOTMUCH_PRIVATE_STATUS_SUCCESS;
}
static Xapian::Document
return notmuch->xapian_db->get_document (doc_id);
}
-static notmuch_private_status_t
-find_unique_document (notmuch_database_t *notmuch,
- const char *prefix_name,
- const char *value,
- Xapian::Document *document,
- unsigned int *doc_id)
-{
- notmuch_private_status_t status;
-
- status = find_unique_doc_id (notmuch, prefix_name, value, doc_id);
-
- if (status) {
- *document = Xapian::Document ();
- return status;
- }
-
- *document = find_document_for_doc_id (notmuch, *doc_id);
- return NOTMUCH_PRIVATE_STATUS_SUCCESS;
-}
-
notmuch_message_t *
notmuch_database_find_message (notmuch_database_t *notmuch,
const char *message_id)
notmuch_private_status_t status;
unsigned int doc_id;
- status = find_unique_doc_id (notmuch, "id", message_id, &doc_id);
+ status = _notmuch_database_find_unique_doc_id (notmuch, "id",
+ message_id, &doc_id);
if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
return NULL;
return notmuch->path;
}
-static notmuch_private_status_t
-find_timestamp_document (notmuch_database_t *notmuch, const char *db_key,
- Xapian::Document *doc, unsigned int *doc_id)
+/* We allow the user to use arbitrarily long paths for directories. But
+ * we have a term-length limit. So if we exceed that, we'll use the
+ * SHA-1 of the path for the database term.
+ *
+ * Note: This function may return the original value of 'path'. If it
+ * does not, then the caller is responsible to free() the returned
+ * value.
+ */
+const char *
+_notmuch_database_get_directory_db_path (const char *path)
{
- return find_unique_document (notmuch, "timestamp", db_key, doc, doc_id);
+ int term_len = strlen (_find_prefix ("directory")) + strlen (path);
+
+ if (term_len > NOTMUCH_TERM_MAX)
+ return notmuch_sha1_of_string (path);
+ else
+ return path;
}
-/* We allow the user to use arbitrarily long keys for timestamps,
- * (they're for filesystem paths after all, which have no limit we
- * know about). But we have a term-length limit. So if we exceed that,
- * we'll use the SHA-1 of the user's key as the actual key for
- * constructing a database term.
+/* Given a path, split it into two parts: the directory part is all
+ * components except for the last, and the basename is that last
+ * component. Getting the return-value for either part is optional
+ * (the caller can pass NULL).
+ *
+ * The original 'path' can represent either a regular file or a
+ * directory---the splitting will be carried out in the same way in
+ * either case. Trailing slashes on 'path' will be ignored, and any
+ * cases of multiple '/' characters appearing in series will be
+ * treated as a single '/'.
*
- * Caution: This function returns a newly allocated string which the
- * caller should free() when finished.
+ * Allocation (if any) will have 'ctx' as the talloc owner. But
+ * pointers will be returned within the original path string whenever
+ * possible.
+ *
+ * Note: If 'path' is non-empty and contains no non-trailing slash,
+ * (that is, consists of a filename with no parent directory), then
+ * the directory returned will be an empty string. However, if 'path'
+ * is an empty string, then both directory and basename will be
+ * returned as NULL.
*/
-static char *
-timestamp_db_key (const char *key)
+notmuch_status_t
+_notmuch_database_split_path (void *ctx,
+ const char *path,
+ const char **directory,
+ const char **basename)
{
- int term_len = strlen (_find_prefix ("timestamp")) + strlen (key);
+ const char *slash;
+
+ if (path == NULL || *path == '\0') {
+ if (directory)
+ *directory = NULL;
+ if (basename)
+ *basename = NULL;
+ return NOTMUCH_STATUS_SUCCESS;
+ }
- if (term_len > NOTMUCH_TERM_MAX)
- return notmuch_sha1_of_string (key);
- else
- return strdup (key);
+ /* Find the last slash (not counting a trailing slash), if any. */
+
+ slash = path + strlen (path) - 1;
+
+ /* First, skip trailing slashes. */
+ while (slash != path) {
+ if (*slash != '/')
+ break;
+
+ --slash;
+ }
+
+ /* Then, find a slash. */
+ while (slash != path) {
+ if (*slash == '/')
+ break;
+
+ if (basename)
+ *basename = slash;
+
+ --slash;
+ }
+
+ /* Finally, skip multiple slashes. */
+ while (slash != path) {
+ if (*slash != '/')
+ break;
+
+ --slash;
+ }
+
+ if (slash == path) {
+ if (directory)
+ *directory = talloc_strdup (ctx, "");
+ if (basename)
+ *basename = path;
+ } else {
+ if (directory)
+ *directory = talloc_strndup (ctx, path, slash - path + 1);
+ }
+
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
+notmuch_status_t
+_notmuch_database_find_directory_id (notmuch_database_t *notmuch,
+ const char *path,
+ unsigned int *directory_id)
+{
+ notmuch_directory_t *directory;
+ notmuch_status_t status;
+
+ if (path == NULL) {
+ *directory_id = 0;
+ return NOTMUCH_STATUS_SUCCESS;
+ }
+
+ directory = _notmuch_directory_create (notmuch, path, &status);
+ if (status) {
+ *directory_id = -1;
+ return status;
+ }
+
+ *directory_id = _notmuch_directory_get_document_id (directory);
+
+ notmuch_directory_destroy (directory);
+
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
+const char *
+_notmuch_database_get_directory_path (void *ctx,
+ notmuch_database_t *notmuch,
+ unsigned int doc_id)
+{
+ Xapian::Document document;
+
+ document = find_document_for_doc_id (notmuch, doc_id);
+
+ return talloc_strdup (ctx, document.get_data ().c_str ());
+}
+
+/* Given a legal 'filename' for the database, (either relative to
+ * database path or absolute with initial components identical to
+ * database path), return a new string (with 'ctx' as the talloc
+ * owner) suitable for use as a direntry term value.
+ *
+ * The necessary directory documents will be created in the database
+ * as needed.
+ */
+notmuch_status_t
+_notmuch_database_filename_to_direntry (void *ctx,
+ notmuch_database_t *notmuch,
+ const char *filename,
+ char **direntry)
+{
+ const char *relative, *directory, *basename;
+ Xapian::docid directory_id;
+ notmuch_status_t status;
+
+ relative = _notmuch_database_relative_path (notmuch, filename);
+
+ status = _notmuch_database_split_path (ctx, relative,
+ &directory, &basename);
+ if (status)
+ return status;
+
+ status = _notmuch_database_find_directory_id (notmuch, directory,
+ &directory_id);
+ if (status)
+ return status;
+
+ *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
+
+ return NOTMUCH_STATUS_SUCCESS;
}
/* Given a legal 'path' for the database, return the relative path.
return relative;
}
-notmuch_status_t
-notmuch_database_set_timestamp (notmuch_database_t *notmuch,
- const char *key, time_t timestamp)
+notmuch_directory_t *
+notmuch_database_get_directory (notmuch_database_t *notmuch,
+ const char *path)
{
- Xapian::Document doc;
- Xapian::WritableDatabase *db;
- unsigned int doc_id;
- notmuch_private_status_t status;
- notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
- char *db_key = NULL;
-
- if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
- fprintf (stderr, "Attempted to update a read-only database.\n");
- return NOTMUCH_STATUS_READONLY_DATABASE;
- }
-
- db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
- db_key = timestamp_db_key (key);
-
- try {
- status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
-
- doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
- Xapian::sortable_serialise (timestamp));
-
- if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
- char *term = talloc_asprintf (NULL, "%s%s",
- _find_prefix ("timestamp"), db_key);
- doc.add_term (term);
- talloc_free (term);
-
- db->add_document (doc);
- } else {
- db->replace_document (doc_id, doc);
- }
-
- } catch (const Xapian::Error &error) {
- fprintf (stderr, "A Xapian exception occurred setting timestamp: %s.\n",
- error.get_msg().c_str());
- notmuch->exception_reported = TRUE;
- ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
- }
-
- if (db_key)
- free (db_key);
-
- return ret;
-}
-
-time_t
-notmuch_database_get_timestamp (notmuch_database_t *notmuch, const char *key)
-{
- Xapian::Document doc;
- unsigned int doc_id;
- notmuch_private_status_t status;
- char *db_key = NULL;
- time_t ret = 0;
-
- db_key = timestamp_db_key (key);
-
- try {
- status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
-
- if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
- goto DONE;
-
- ret = Xapian::sortable_unserialise (doc.get_value (NOTMUCH_VALUE_TIMESTAMP));
- } catch (Xapian::Error &error) {
- ret = 0;
- goto DONE;
- }
-
- DONE:
- if (db_key)
- free (db_key);
+ notmuch_status_t status;
- return ret;
+ return _notmuch_directory_create (notmuch, path, &status);
}
/* Find the thread ID to which the message with 'message_id' belongs.
goto DONE;
}
+ _notmuch_message_add_filename (message, filename);
+
/* Is this a newly created message object? */
if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
- _notmuch_message_set_filename (message, filename);
_notmuch_message_add_term (message, "type", "mail");
- } else {
- ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
- goto DONE;
- }
- ret = _notmuch_database_link_message (notmuch, message, message_file);
- if (ret)
- goto DONE;
+ ret = _notmuch_database_link_message (notmuch, message,
+ message_file);
+ if (ret)
+ goto DONE;
- date = notmuch_message_file_get_header (message_file, "date");
- _notmuch_message_set_date (message, date);
+ date = notmuch_message_file_get_header (message_file, "date");
+ _notmuch_message_set_date (message, date);
- _notmuch_message_index_file (message, filename);
+ _notmuch_message_index_file (message, filename);
+ } else {
+ ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
+ }
_notmuch_message_sync (message);
} catch (const Xapian::Error &error) {
return ret;
}
+notmuch_status_t
+notmuch_database_remove_message (notmuch_database_t *notmuch,
+ const char *filename)
+{
+ Xapian::WritableDatabase *db;
+ void *local = talloc_new (notmuch);
+ const char *prefix = _find_prefix ("file-direntry");
+ char *direntry, *term;
+ Xapian::PostingIterator i, end;
+ Xapian::Document document;
+ notmuch_status_t status;
+
+ if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
+ fprintf (stderr, "Attempted to update a read-only database.\n");
+ return NOTMUCH_STATUS_READONLY_DATABASE;
+ }
+
+ db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
+
+ status = _notmuch_database_filename_to_direntry (local, notmuch,
+ filename, &direntry);
+ if (status)
+ return status;
+
+ term = talloc_asprintf (notmuch, "%s%s", prefix, direntry);
+
+ find_doc_ids_for_term (notmuch, term, &i, &end);
+
+ for ( ; i != end; i++) {
+ Xapian::TermIterator j;
+
+ document = find_document_for_doc_id (notmuch, *i);
+
+ document.remove_term (term);
+
+ j = document.termlist_begin ();
+ j.skip_to (prefix);
+
+ /* Was this the last file-direntry in the message? */
+ if (j == document.termlist_end () ||
+ strncmp ((*j).c_str (), prefix, strlen (prefix)))
+ {
+ db->delete_document (document.get_docid ());
+ status = NOTMUCH_STATUS_SUCCESS;
+ } else {
+ db->replace_document (document.get_docid (), document);
+ status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
+ }
+ }
+
+ talloc_free (local);
+
+ return status;
+}
+
notmuch_tags_t *
_notmuch_convert_tags (void *ctx, Xapian::TermIterator &i,
Xapian::TermIterator &end)