notmuch/lib/directory.cc

/* 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);
}