*
* tag: Any tags associated with this message by the user.
*
- * 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.
+ * 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:
*
* maintain data necessary to allow for efficient polling of mail
* directories.
*
- * The directory document contains the following terms:
+ * All directory documents contain one 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).
*
- * parent: The document ID of the parent directory document.
- * Top-level directories will have a parent value of 0.
+ * 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.
+ *
+ * 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 datbase path).
+ * 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" },
- { "directory", "XDIRECTORY" },
- { "direntry", "XDIRENTRY" },
- { "parent", "XPARENT" },
+ { "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
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;
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_directory_document (notmuch_database_t *notmuch, const char *db_path,
- Xapian::Document *doc, unsigned int *doc_id)
-{
- return find_unique_document (notmuch, "directory", db_path, doc, 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.
* does not, then the caller is responsible to free() the returned
* value.
*/
-static const char *
-directory_db_path (const char *path)
+const char *
+_notmuch_database_get_directory_db_path (const char *path)
{
int term_len = strlen (_find_prefix ("directory")) + strlen (path);
const char *path,
unsigned int *directory_id)
{
- notmuch_private_status_t private_status;
- notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
- const char *db_path;
+ notmuch_directory_t *directory;
+ notmuch_status_t status;
if (path == NULL) {
*directory_id = 0;
return NOTMUCH_STATUS_SUCCESS;
}
- db_path = directory_db_path (path);
-
- private_status = find_unique_doc_id (notmuch, "directory",
- db_path, directory_id);
- if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
- status = notmuch_database_set_directory_mtime (notmuch,
- path, 0);
- if (status)
- goto DONE;
-
- private_status = find_unique_doc_id (notmuch, "directory",
- db_path, directory_id);
- status = COERCE_STATUS (private_status, "_find_directory_id");
+ directory = _notmuch_directory_create (notmuch, path, &status);
+ if (status) {
+ *directory_id = -1;
+ return status;
}
- DONE:
- if (db_path != path)
- free ((char *) db_path);
+ *directory_id = _notmuch_directory_get_document_id (directory);
- if (status)
- *directory_id = -1;
+ notmuch_directory_destroy (directory);
- return status;
+ return NOTMUCH_STATUS_SUCCESS;
}
const char *
return relative;
}
-notmuch_status_t
-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;
- const char *parent, *db_path = NULL;
- unsigned int parent_id;
- void *local = talloc_new (notmuch);
-
- 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_path = directory_db_path (path);
-
- try {
- status = find_directory_document (notmuch, db_path, &doc, &doc_id);
-
- doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
- Xapian::sortable_serialise (mtime));
-
- if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
- char *term = talloc_asprintf (local, "%s%s",
- _find_prefix ("directory"), db_path);
- doc.add_term (term);
-
- doc.set_data (path);
-
- _notmuch_database_split_path (local, path, &parent, NULL);
-
- _notmuch_database_find_directory_id (notmuch, parent, &parent_id);
-
- term = talloc_asprintf (local, "%s%u",
- _find_prefix ("parent"),
- parent_id);
- doc.add_term (term);
-
- db->add_document (doc);
- } else {
- db->replace_document (doc_id, doc);
- }
-
- } catch (const Xapian::Error &error) {
- 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_path != path)
- free ((char *) db_path);
-
- talloc_free (local);
-
- return ret;
-}
-
-time_t
-notmuch_database_get_directory_mtime (notmuch_database_t *notmuch,
- const char *path)
+notmuch_directory_t *
+notmuch_database_get_directory (notmuch_database_t *notmuch,
+ const char *path)
{
- Xapian::Document doc;
- unsigned int doc_id;
- notmuch_private_status_t status;
- const char *db_path = NULL;
- time_t ret = 0;
-
- db_path = directory_db_path (path);
-
- try {
- status = find_directory_document (notmuch, db_path, &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_path != path)
- free ((char *) db_path);
+ 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.
{
Xapian::WritableDatabase *db;
void *local = talloc_new (notmuch);
- const char *direntry_prefix = _find_prefix ("direntry");
+ const char *prefix = _find_prefix ("file-direntry");
char *direntry, *term;
Xapian::PostingIterator i, end;
Xapian::Document document;
if (status)
return status;
- term = talloc_asprintf (notmuch, "%s%s", direntry_prefix, direntry);
+ term = talloc_asprintf (notmuch, "%s%s", prefix, direntry);
find_doc_ids_for_term (notmuch, term, &i, &end);
document.remove_term (term);
j = document.termlist_begin ();
- j.skip_to (direntry_prefix);
+ j.skip_to (prefix);
- /* Was this the last direntry in the message? */
+ /* Was this the last file-direntry in the message? */
if (j == document.termlist_end () ||
- strncmp ((*j).c_str (), direntry_prefix, strlen (direntry_prefix)))
+ strncmp ((*j).c_str (), prefix, strlen (prefix)))
{
db->delete_document (document.get_docid ());
} else {
--- /dev/null
+/* directory.cc - Results of directory-based searches from a notmuch database
+ *
+ * Copyright © 2009 Carl Worth
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/ .
+ *
+ * Author: Carl Worth <cworth@cworth.org>
+ */
+
+#include "notmuch-private.h"
+#include "database-private.h"
+
+#include <xapian.h>
+
+struct _notmuch_filenames {
+ Xapian::TermIterator iterator;
+ Xapian::TermIterator end;
+ int prefix_len;
+ char *filename;
+};
+
+/* We end up having to call the destructors explicitly because we had
+ * to use "placement new" in order to initialize C++ objects within a
+ * block that we allocated with talloc. So C++ is making talloc
+ * slightly less simple to use, (we wouldn't need
+ * talloc_set_destructor at all otherwise).
+ */
+static int
+_notmuch_filenames_destructor (notmuch_filenames_t *filenames)
+{
+ filenames->iterator.~TermIterator ();
+ filenames->end.~TermIterator ();
+
+ return 0;
+}
+
+/* Create an iterator to iterate over the basenames of files (or
+ * directories) that all share a common parent directory.
+ *
+ * The code here is general enough to be reused for any case of
+ * iterating over the non-prefixed portion of terms sharing a common
+ * prefix.
+ */
+notmuch_filenames_t *
+_notmuch_filenames_create (void *ctx,
+ notmuch_database_t *notmuch,
+ const char *prefix)
+{
+ notmuch_filenames_t *filenames;
+
+ filenames = talloc (ctx, notmuch_filenames_t);
+ if (unlikely (filenames == NULL))
+ return NULL;
+
+ new (&filenames->iterator) Xapian::TermIterator ();
+ new (&filenames->end) Xapian::TermIterator ();
+
+ talloc_set_destructor (filenames, _notmuch_filenames_destructor);
+
+ filenames->iterator = notmuch->xapian_db->allterms_begin (prefix);
+ filenames->end = notmuch->xapian_db->allterms_end (prefix);
+
+ filenames->prefix_len = strlen (prefix);
+
+ filenames->filename = NULL;
+
+ return filenames;
+}
+
+notmuch_bool_t
+notmuch_filenames_has_more (notmuch_filenames_t *filenames)
+{
+ return (filenames->iterator != filenames->end);
+}
+
+const char *
+notmuch_filenames_get (notmuch_filenames_t *filenames)
+{
+ if (filenames->filename == NULL) {
+ std::string term = *filenames->iterator;
+
+ filenames->filename = talloc_strdup (filenames,
+ term.c_str () +
+ filenames->prefix_len);
+ }
+
+ return filenames->filename;
+}
+
+void
+notmuch_filenames_advance (notmuch_filenames_t *filenames)
+{
+ if (filenames->filename) {
+ talloc_free (filenames->filename);
+ filenames->filename = NULL;
+ }
+
+ if (filenames->iterator != filenames->end)
+ filenames->iterator++;
+}
+
+void
+notmuch_filenames_destroy (notmuch_filenames_t *filenames)
+{
+ talloc_free (filenames);
+}
+
+struct _notmuch_directory {
+ notmuch_database_t *notmuch;
+ Xapian::docid document_id;
+ Xapian::Document doc;
+ time_t mtime;
+};
+
+/* We end up having to call the destructor explicitly because we had
+ * to use "placement new" in order to initialize C++ objects within a
+ * block that we allocated with talloc. So C++ is making talloc
+ * slightly less simple to use, (we wouldn't need
+ * talloc_set_destructor at all otherwise).
+ */
+static int
+_notmuch_directory_destructor (notmuch_directory_t *directory)
+{
+ directory->doc.~Document ();
+
+ return 0;
+}
+
+static notmuch_private_status_t
+find_directory_document (notmuch_database_t *notmuch,
+ const char *db_path,
+ Xapian::Document *document)
+{
+ notmuch_private_status_t status;
+ Xapian::docid doc_id;
+
+ status = _notmuch_database_find_unique_doc_id (notmuch, "directory",
+ db_path, &doc_id);
+ if (status) {
+ *document = Xapian::Document ();
+ return status;
+ }
+
+ *document = notmuch->xapian_db->get_document (doc_id);
+ return NOTMUCH_PRIVATE_STATUS_SUCCESS;
+}
+
+notmuch_directory_t *
+_notmuch_directory_create (notmuch_database_t *notmuch,
+ const char *path,
+ notmuch_status_t *status_ret)
+{
+ Xapian::WritableDatabase *db;
+ notmuch_directory_t *directory;
+ notmuch_private_status_t private_status;
+ const char *db_path;
+
+ *status_ret = NOTMUCH_STATUS_SUCCESS;
+
+ path = _notmuch_database_relative_path (notmuch, path);
+
+ if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
+ fprintf (stderr, "Attempted to update a read-only database.\n");
+ *status_ret = NOTMUCH_STATUS_READONLY_DATABASE;
+ return NULL;
+ }
+
+ db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
+
+ directory = talloc (notmuch, notmuch_directory_t);
+ if (unlikely (directory == NULL))
+ return NULL;
+
+ directory->notmuch = notmuch;
+
+ /* "placement new"---not actually allocating memory */
+ new (&directory->doc) Xapian::Document;
+
+ talloc_set_destructor (directory, _notmuch_directory_destructor);
+
+ db_path = _notmuch_database_get_directory_db_path (path);
+
+ try {
+ Xapian::TermIterator i, end;
+
+ private_status = find_directory_document (notmuch, db_path,
+ &directory->doc);
+ directory->document_id = directory->doc.get_docid ();
+
+ if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
+ void *local = talloc_new (directory);
+ const char *parent, *basename;
+ Xapian::docid parent_id;
+ char *term = talloc_asprintf (local, "%s%s",
+ _find_prefix ("directory"), db_path);
+ directory->doc.add_term (term);
+
+ directory->doc.set_data (path);
+
+ _notmuch_database_split_path (local, path, &parent, &basename);
+
+ _notmuch_database_find_directory_id (notmuch, parent, &parent_id);
+
+ if (basename) {
+ term = talloc_asprintf (local, "%s%u:%s",
+ _find_prefix ("directory-direntry"),
+ parent_id, basename);
+ directory->doc.add_term (term);
+ }
+
+ directory->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
+ Xapian::sortable_serialise (0));
+
+ directory->document_id = db->add_document (directory->doc);
+ talloc_free (local);
+ }
+
+ directory->mtime = Xapian::sortable_unserialise (
+ directory->doc.get_value (NOTMUCH_VALUE_TIMESTAMP));
+ } catch (const Xapian::Error &error) {
+ fprintf (stderr,
+ "A Xapian exception occurred creating a directory: %s.\n",
+ error.get_msg().c_str());
+ notmuch->exception_reported = TRUE;
+ notmuch_directory_destroy (directory);
+ *status_ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+ return NULL;
+ }
+
+ if (db_path != path)
+ free ((char *) db_path);
+
+ return directory;
+}
+
+unsigned int
+_notmuch_directory_get_document_id (notmuch_directory_t *directory)
+{
+ return directory->document_id;
+}
+
+notmuch_status_t
+notmuch_directory_set_mtime (notmuch_directory_t *directory,
+ time_t mtime)
+{
+ notmuch_database_t *notmuch = directory->notmuch;
+ Xapian::WritableDatabase *db;
+
+ 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);
+
+ try {
+ directory->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
+ Xapian::sortable_serialise (mtime));
+
+ db->replace_document (directory->document_id, directory->doc);
+ } catch (const Xapian::Error &error) {
+ fprintf (stderr,
+ "A Xapian exception occurred setting directory mtime: %s.\n",
+ error.get_msg().c_str());
+ notmuch->exception_reported = TRUE;
+ return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+ }
+
+ return NOTMUCH_STATUS_SUCCESS;
+}
+
+time_t
+notmuch_directory_get_mtime (notmuch_directory_t *directory)
+{
+ return directory->mtime;
+}
+
+notmuch_filenames_t *
+notmuch_directory_get_child_files (notmuch_directory_t *directory)
+{
+ char *term;
+ notmuch_filenames_t *child_files;
+
+ term = talloc_asprintf (directory, "%s%u:",
+ _find_prefix ("file-direntry"),
+ directory->document_id);
+
+ child_files = _notmuch_filenames_create (directory,
+ directory->notmuch, term);
+
+ talloc_free (term);
+
+ return child_files;
+}
+
+notmuch_filenames_t *
+notmuch_directory_get_child_directories (notmuch_directory_t *directory)
+{
+ char *term;
+ notmuch_filenames_t *child_directories;
+
+ term = talloc_asprintf (directory, "%s%u:",
+ _find_prefix ("directory-direntry"),
+ directory->document_id);
+
+ child_directories = _notmuch_filenames_create (directory,
+ directory->notmuch, term);
+
+ talloc_free (term);
+
+ return child_directories;
+}
+
+void
+notmuch_directory_destroy (notmuch_directory_t *directory)
+{
+ talloc_free (directory);
+}
projects / notmuch / commitdiff