/* 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
* -------------
* user in searching. But the database doesn't really care itself
* about any of these.
*
- * Timestamp document
+ * Finally, the data portion of a mail document contains the path name
+ * of the mail message (relative to the database path).
+ *
+ * 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.
*
- * The timestamp document is indexed with a single prefixed term:
+ * The directory document contains the following terms:
*
- * timestamp: The user's key value (likely a directory name)
+ * directory: The directory path (relative to the database path)
+ * parent: The document ID of the parent directory document.
+ * Top-level directories will have a parent value of 0.
*
* and has a single value:
*
- * TIMESTAMP: The time_t value from the user.
+ * TIMESTAMP: The mtime of the directory (at last scan)
*/
/* With these prefix values we follow the conventions published here:
{ "type", "T" },
{ "reference", "XREFERENCE" },
{ "replyto", "XREPLYTO" },
- { "timestamp", "XTIMESTAMP" },
+ { "directory", "XDIRECTORY" },
+ { "parent", "XPARENT" },
};
prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
}
static notmuch_private_status_t
-find_timestamp_document (notmuch_database_t *notmuch, const char *db_key,
+find_directory_document (notmuch_database_t *notmuch, const char *db_path,
Xapian::Document *doc, unsigned int *doc_id)
{
- return find_unique_document (notmuch, "timestamp", db_key, doc, doc_id);
+ return find_unique_document (notmuch, "directory", db_path, doc, doc_id);
}
-/* 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.
+/* 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.
*
- * Caution: This function returns a newly allocated string which the
- * caller should free() when finished.
+ * Note: This function may return the original value of 'path'. If it
+ * does not, then the caller is responsible to free() the returned
+ * value.
*/
-static char *
-timestamp_db_key (const char *key)
+static const char *
+directory_db_path (const char *path)
{
- int term_len = strlen (_find_prefix ("timestamp")) + strlen (key);
+ int term_len = strlen (_find_prefix ("directory")) + strlen (path);
if (term_len > NOTMUCH_TERM_MAX)
- return notmuch_sha1_of_string (key);
+ return notmuch_sha1_of_string (path);
+ else
+ return path;
+}
+
+/* Given a 'path' (relative to the database path) return the document
+ * ID of the directory document corresponding to the parent directory
+ * of 'path' in 'parent_id'.
+ *
+ * The original 'path' can represent either a regular file or a
+ * directory, (in either case, the document ID of the parent will be
+ * returned). Trailing slashes on 'path' will be ignored, and any
+ * cases of multiple '/' characters appearing in series will be
+ * treated as a single '/'.
+ *
+ * If no directory document exists in the database for the parent, (or
+ * for any of its parents up to the top-level database path), then
+ * directory documents will be created for these (each with an mtime
+ * of 0).
+ *
+ * Return value:
+ *
+ * NOTMUCH_STATUS_SUCCESS: Valid value available in parent_id.
+ *
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
+ * occurred and parent_id will be set to (unsigned) -1.
+ */
+notmuch_status_t
+_notmuch_database_find_parent_id (notmuch_database_t *notmuch,
+ const char *path,
+ unsigned int *parent_id)
+{
+ const char *slash, *parent_db_path;
+ char *parent_path;
+ notmuch_private_status_t private_status;
+ notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+
+ if (path == NULL || *path == '\0') {
+ *parent_id = 0;
+ return NOTMUCH_STATUS_SUCCESS;
+ }
+
+ /* 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;
+
+ --slash;
+ }
+
+ /* Finally, skip multiple slashes. */
+ while (slash != path) {
+ if (*slash != '/')
+ break;
+
+ --slash;
+ }
+
+ if (slash == path)
+ parent_path = talloc_strdup (notmuch, "");
else
- return strdup (key);
+ parent_path = talloc_strndup (notmuch, path, slash - path + 1);
+
+ parent_db_path = directory_db_path (parent_path);
+
+ private_status = find_unique_doc_id (notmuch, "directory",
+ parent_db_path, parent_id);
+ if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
+ status = notmuch_database_set_directory_mtime (notmuch,
+ parent_path, 0);
+ if (status)
+ return status;
+ private_status = find_unique_doc_id (notmuch, "directory",
+ parent_db_path, parent_id);
+ status = COERCE_STATUS (private_status, "_find_parent_id");
+ }
+
+ if (parent_db_path != parent_path)
+ free ((char *) parent_db_path);
+
+ talloc_free (parent_path);
+
+ if (status)
+ *parent_id = -1;
+
+ return status;
+}
+
+/* Given a legal 'path' for the database, return the relative path.
+ *
+ * The return value will be a pointer to the originl path contents,
+ * and will be either the original string (if 'path' was relative) or
+ * a portion of the string (if path was absolute and begins with the
+ * database path).
+ */
+const char *
+_notmuch_database_relative_path (notmuch_database_t *notmuch,
+ const char *path)
+{
+ const char *db_path, *relative;
+ unsigned int db_path_len;
+
+ db_path = notmuch_database_get_path (notmuch);
+ db_path_len = strlen (db_path);
+
+ relative = path;
+
+ if (*relative == '/') {
+ while (*relative == '/' && *(relative+1) == '/')
+ relative++;
+
+ if (strncmp (relative, db_path, db_path_len) == 0)
+ {
+ relative += db_path_len;
+ while (*relative == '/')
+ relative++;
+ }
+ }
+
+ return relative;
}
notmuch_status_t
-notmuch_database_set_timestamp (notmuch_database_t *notmuch,
- const char *key, time_t timestamp)
+notmuch_database_set_directory_mtime (notmuch_database_t *notmuch,
+ const char *path,
+ time_t mtime)
{
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;
+ const char *db_path = NULL;
+ unsigned int parent_id;
if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
fprintf (stderr, "Attempted to update a read-only database.\n");
return NOTMUCH_STATUS_READONLY_DATABASE;
}
+ path = _notmuch_database_relative_path (notmuch, path);
+
db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
- db_key = timestamp_db_key (key);
+ db_path = directory_db_path (path);
try {
- status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
+ status = find_directory_document (notmuch, db_path, &doc, &doc_id);
doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
- Xapian::sortable_serialise (timestamp));
+ Xapian::sortable_serialise (mtime));
if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
char *term = talloc_asprintf (NULL, "%s%s",
- _find_prefix ("timestamp"), db_key);
+ _find_prefix ("directory"), db_path);
+ doc.add_term (term);
+ talloc_free (term);
+
+ ret = _notmuch_database_find_parent_id (notmuch, path,
+ &parent_id);
+ if (ret)
+ return ret;
+
+ term = talloc_asprintf (NULL, "%s%u",
+ _find_prefix ("parent"),
+ parent_id);
doc.add_term (term);
talloc_free (term);
}
} catch (const Xapian::Error &error) {
- fprintf (stderr, "A Xapian exception occurred setting timestamp: %s.\n",
+ fprintf (stderr, "A Xapian exception occurred setting directory mtime: %s.\n",
error.get_msg().c_str());
notmuch->exception_reported = TRUE;
ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
}
- if (db_key)
- free (db_key);
+ if (db_path != path)
+ free ((char *) db_path);
return ret;
}
time_t
-notmuch_database_get_timestamp (notmuch_database_t *notmuch, const char *key)
+notmuch_database_get_directory_mtime (notmuch_database_t *notmuch,
+ const char *path)
{
Xapian::Document doc;
unsigned int doc_id;
notmuch_private_status_t status;
- char *db_key = NULL;
+ const char *db_path = NULL;
time_t ret = 0;
- db_key = timestamp_db_key (key);
+ db_path = directory_db_path (path);
try {
- status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
+ status = find_directory_document (notmuch, db_path, &doc, &doc_id);
if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
goto DONE;
}
DONE:
- if (db_key)
- free (db_key);
+ if (db_path != path)
+ free ((char *) db_path);
return ret;
}
*
* We first look at 'message_file' and its link-relevant headers
* (References and In-Reply-To) for message IDs. We also look in the
- * database for existing message that reference 'message'.p
+ * database for existing message that reference 'message'.
*
- * The end result is to call _notmuch_message_add_thread_id with one
- * or more thread IDs to which this message belongs, (including
- * generating a new thread ID if necessary if the message doesn't
- * connect to any existing threads).
+ * The end result is to call _notmuch_message_ensure_thread_id which
+ * generates a new thread ID if the message doesn't connect to any
+ * existing threads.
*/
static notmuch_status_t
_notmuch_database_link_message (notmuch_database_t *notmuch,
projects / notmuch / blobdiff