]> git.notmuchmail.org Git - notmuch/blobdiff - lib/directory.cc
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / lib / directory.cc
index 5d673e2134d058b8010d96d9783d187e765b96a0..5cf64d7fc4021748b8d686cf36ed758741161db0 100644 (file)
@@ -13,7 +13,7 @@
  * 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/ .
+ * along with this program.  If not, see https://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)
+static notmuch_filenames_t *
+_create_filenames_for_terms_with_prefix (void *ctx,
+                                        notmuch_database_t *notmuch,
+                                        const char *prefix)
 {
-    notmuch_filenames_t *filenames;
-
-    filenames = talloc (ctx, notmuch_filenames_t);
-    if (unlikely (filenames == NULL))
+    notmuch_string_list_t *filename_list;
+    Xapian::TermIterator i, end;
+
+    i = notmuch->xapian_db->allterms_begin ();
+    end = notmuch->xapian_db->allterms_end ();
+    filename_list = _notmuch_database_get_terms_with_prefix (ctx, i, end,
+                                                            prefix);
+    if (unlikely (filename_list == 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_valid (notmuch_filenames_t *filenames)
-{
-    if (filenames == NULL)
-       return NULL;
-
-    return (filenames->iterator != filenames->end);
-}
-
-const char *
-notmuch_filenames_get (notmuch_filenames_t *filenames)
-{
-    if (filenames == NULL || filenames->iterator == filenames->end)
-       return NULL;
-
-    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_move_to_next (notmuch_filenames_t *filenames)
-{
-    if (filenames == NULL)
-       return;
-
-    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)
-{
-    if (filenames == NULL)
-       return;
-
-    talloc_free (filenames);
+    return _notmuch_filenames_create (ctx, filename_list);
 }
 
 struct _notmuch_directory {
@@ -135,6 +49,21 @@ struct _notmuch_directory {
     time_t mtime;
 };
 
+#define LOG_XAPIAN_EXCEPTION(directory, error) _log_xapian_exception (__location__, directory, error)
+
+static void
+_log_xapian_exception (const char *where, notmuch_directory_t *dir,  const Xapian::Error error)
+{
+    notmuch_database_t *notmuch = dir->notmuch;
+
+    _notmuch_database_log (notmuch,
+                          "A Xapian exception occurred at %s: %s\n",
+                          where,
+                          error.get_msg ().c_str ());
+    notmuch->exception_reported = true;
+}
+
+
 /* 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
@@ -168,28 +97,45 @@ find_directory_document (notmuch_database_t *notmuch,
     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 }
 
+/* Find or create a directory document.
+ *
+ * 'path' should be a path relative to the path of 'database', or else
+ * should be an absolute path with initial components that match the
+ * path of 'database'.
+ *
+ * If (flags & NOTMUCH_FIND_CREATE), then the directory document will
+ * be created if it does not exist.  Otherwise, if the directory
+ * document does not exist, *status_ret is set to
+ * NOTMUCH_STATUS_SUCCESS and this returns NULL.
+ */
 notmuch_directory_t *
-_notmuch_directory_create (notmuch_database_t *notmuch,
-                          const char *path,
-                          notmuch_status_t *status_ret)
+_notmuch_directory_find_or_create (notmuch_database_t *notmuch,
+                                  const char *path,
+                                  notmuch_find_flags_t flags,
+                                  notmuch_status_t *status_ret)
 {
-    Xapian::WritableDatabase *db;
     notmuch_directory_t *directory;
     notmuch_private_status_t private_status;
     const char *db_path;
+    bool create = (flags & NOTMUCH_FIND_CREATE);
+
+    if (! (notmuch->features & NOTMUCH_FEATURE_DIRECTORY_DOCS)) {
+       *status_ret = NOTMUCH_STATUS_UPGRADE_REQUIRED;
+       return NULL;
+    }
 
     *status_ret = NOTMUCH_STATUS_SUCCESS;
 
     path = _notmuch_database_relative_path (notmuch, path);
 
-    if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
+    if (create && _notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY)
        INTERNAL_ERROR ("Failure to ensure database is writable");
 
-    db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
-
     directory = talloc (notmuch, notmuch_directory_t);
-    if (unlikely (directory == NULL))
+    if (unlikely (directory == NULL)) {
+       *status_ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
        return NULL;
+    }
 
     directory->notmuch = notmuch;
 
@@ -208,6 +154,13 @@ _notmuch_directory_create (notmuch_database_t *notmuch,
        directory->document_id = directory->doc.get_docid ();
 
        if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
+           if (! create) {
+               notmuch_directory_destroy (directory);
+               directory = NULL;
+               *status_ret = NOTMUCH_STATUS_SUCCESS;
+               goto DONE;
+           }
+
            void *local = talloc_new (directory);
            const char *parent, *basename;
            Xapian::docid parent_id;
@@ -219,7 +172,13 @@ _notmuch_directory_create (notmuch_database_t *notmuch,
 
            _notmuch_database_split_path (local, path, &parent, &basename);
 
-           _notmuch_database_find_directory_id (notmuch, parent, &parent_id);
+           *status_ret = _notmuch_database_find_directory_id (
+               notmuch, parent, NOTMUCH_FIND_CREATE, &parent_id);
+           if (*status_ret) {
+               notmuch_directory_destroy (directory);
+               directory = NULL;
+               goto DONE;
+           }
 
            if (basename) {
                term = talloc_asprintf (local, "%s%u:%s",
@@ -232,22 +191,25 @@ _notmuch_directory_create (notmuch_database_t *notmuch,
                                      Xapian::sortable_serialise (0));
 
            directory->document_id = _notmuch_database_generate_doc_id (notmuch);
-           db->replace_document (directory->document_id, directory->doc);
+           directory->notmuch->
+               writable_xapian_db
+               -> replace_document (directory->document_id, 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_database_log (notmuch,
+                              "A Xapian exception occurred finding/creating a directory: %s.\n",
+                              error.get_msg ().c_str ());
+       notmuch->exception_reported = true;
        notmuch_directory_destroy (directory);
+       directory = NULL;
        *status_ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
-       return NULL;
     }
 
+  DONE:
     if (db_path != path)
        free ((char *) db_path);
 
@@ -265,25 +227,26 @@ notmuch_directory_set_mtime (notmuch_directory_t *directory,
                             time_t mtime)
 {
     notmuch_database_t *notmuch = directory->notmuch;
-    Xapian::WritableDatabase *db;
     notmuch_status_t status;
 
     status = _notmuch_database_ensure_writable (notmuch);
     if (status)
        return status;
 
-    db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
-
     try {
        directory->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
-                                  Xapian::sortable_serialise (mtime));
+                                 Xapian::sortable_serialise (mtime));
+
+       directory->notmuch
+           ->writable_xapian_db->replace_document (directory->document_id, directory->doc);
+
+       directory->mtime = 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;
+       _notmuch_database_log (notmuch,
+                              "A Xapian exception occurred setting directory mtime: %s.\n",
+                              error.get_msg ().c_str ());
+       notmuch->exception_reported = true;
        return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
     }
 
@@ -300,14 +263,19 @@ notmuch_filenames_t *
 notmuch_directory_get_child_files (notmuch_directory_t *directory)
 {
     char *term;
-    notmuch_filenames_t *child_files;
+    notmuch_filenames_t *child_files = NULL;
 
     term = talloc_asprintf (directory, "%s%u:",
                            _find_prefix ("file-direntry"),
                            directory->document_id);
 
-    child_files = _notmuch_filenames_create (directory,
-                                            directory->notmuch, term);
+    try {
+       child_files = _create_filenames_for_terms_with_prefix (directory,
+                                                              directory->notmuch,
+                                                              term);
+    } catch (Xapian::Error &error) {
+       LOG_XAPIAN_EXCEPTION (directory, error);
+    }
 
     talloc_free (term);
 
@@ -318,20 +286,48 @@ notmuch_filenames_t *
 notmuch_directory_get_child_directories (notmuch_directory_t *directory)
 {
     char *term;
-    notmuch_filenames_t *child_directories;
+    notmuch_filenames_t *child_directories = NULL;
 
     term = talloc_asprintf (directory, "%s%u:",
                            _find_prefix ("directory-direntry"),
                            directory->document_id);
 
-    child_directories = _notmuch_filenames_create (directory,
-                                                  directory->notmuch, term);
+    try {
+       child_directories = _create_filenames_for_terms_with_prefix (directory,
+                                                                    directory->notmuch, term);
+    } catch (Xapian::Error &error) {
+       LOG_XAPIAN_EXCEPTION (directory, error);
+    }
 
     talloc_free (term);
 
     return child_directories;
 }
 
+notmuch_status_t
+notmuch_directory_delete (notmuch_directory_t *directory)
+{
+    notmuch_status_t status;
+
+    status = _notmuch_database_ensure_writable (directory->notmuch);
+    if (status)
+       return status;
+
+    try {
+       directory->notmuch->
+           writable_xapian_db->delete_document (directory->document_id);
+    } catch (const Xapian::Error &error) {
+       _notmuch_database_log (directory->notmuch,
+                              "A Xapian exception occurred deleting directory entry: %s.\n",
+                              error.get_msg ().c_str ());
+       directory->notmuch->exception_reported = true;
+       status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+    }
+    notmuch_directory_destroy (directory);
+
+    return status;
+}
+
 void
 notmuch_directory_destroy (notmuch_directory_t *directory)
 {