]> git.notmuchmail.org Git - notmuch/blobdiff - lib/database.cc
database: Make find_unique_doc_id enforce uniqueness (for a debug build)
[notmuch] / lib / database.cc
index dbfec63031b367bab636c6c83180703ca6c0cbd5..5d300732d4a635a369b569ddbe452f39bff73f59 100644 (file)
@@ -63,6 +63,11 @@ typedef struct {
  *
  *     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.
+ *
  *    A mail document also has two values:
  *
  *     TIMESTAMP:      The time_t value corresponding to the message's
@@ -75,8 +80,7 @@ typedef struct {
  * user in searching. But the database doesn't really care itself
  * about any of these.
  *
- * Finally, the data portion of a mail document contains the path name
- * of the mail message (relative to the database path).
+ * The data portion of a mail document is empty.
  *
  * Directory document
  * ------------------
@@ -122,6 +126,7 @@ prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
     { "reference", "XREFERENCE" },
     { "replyto", "XREPLYTO" },
     { "directory", "XDIRECTORY" },
+    { "direntry", "XDIRENTRY" },
     { "parent", "XPARENT" },
 };
 
@@ -241,10 +246,19 @@ find_unique_doc_id (notmuch_database_t *notmuch,
     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
@@ -597,40 +611,40 @@ directory_db_path (const char *path)
        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'.
+/* 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, (in either case, the document ID of the parent will be
- * returned). Trailing slashes on 'path' will be ignored, and any
+ * 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 '/'.
  *
- * 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.
+ * Allocation (if any) will have 'ctx' as the talloc owner. But
+ * pointers will be returned within the original path string whenever
+ * possible.
  *
- * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
- *     occurred and parent_id will be set to (unsigned) -1.
+ * 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.
  */
 notmuch_status_t
-_notmuch_database_find_parent_id (notmuch_database_t *notmuch,
-                                 const char *path,
-                                 unsigned int *parent_id)
+_notmuch_database_split_path (void *ctx,
+                             const char *path,
+                             const char **directory,
+                             const char **basename)
 {
-    const char *slash, *parent_db_path;
-    char *parent_path;
-    notmuch_private_status_t private_status;
-    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+    const char *slash;
 
     if (path == NULL || *path == '\0') {
-       *parent_id = 0;
+       if (directory)
+           *directory = NULL;
+       if (basename)
+           *basename = NULL;
        return NOTMUCH_STATUS_SUCCESS;
     }
 
@@ -651,6 +665,9 @@ _notmuch_database_find_parent_id (notmuch_database_t *notmuch,
        if (*slash == '/')
            break;
 
+       if (basename)
+           *basename = slash;
+
        --slash;
     }
 
@@ -662,36 +679,102 @@ _notmuch_database_find_parent_id (notmuch_database_t *notmuch,
        --slash;
     }
 
-    if (slash == path)
-       parent_path = talloc_strdup (notmuch, "");
-    else
-       parent_path = talloc_strndup (notmuch, path, slash - path + 1);
+    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;
+}
 
-    parent_db_path = directory_db_path (parent_path);
+notmuch_status_t
+_notmuch_database_find_directory_id (notmuch_database_t *notmuch,
+                                    const char *path,
+                                    unsigned int *directory_id)
+{
+    notmuch_private_status_t private_status;
+    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+    const char *db_path;
+
+    if (path == NULL) {
+       *directory_id = 0;
+       return NOTMUCH_STATUS_SUCCESS;
+    }
+
+    db_path = directory_db_path (path);
 
     private_status = find_unique_doc_id (notmuch, "directory",
-                                        parent_db_path, parent_id);
+                                        db_path, directory_id);
     if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
        status = notmuch_database_set_directory_mtime (notmuch,
-                                                      parent_path, 0);
+                                                      path, 0);
        if (status)
-           return status;
+           goto DONE;
+
        private_status = find_unique_doc_id (notmuch, "directory",
-                                            parent_db_path, parent_id);
-       status = COERCE_STATUS (private_status, "_find_parent_id");
+                                            db_path, directory_id);
+       status = COERCE_STATUS (private_status, "_find_directory_id");
     }
 
-    if (parent_db_path != parent_path)
-       free ((char *) parent_db_path);
-
-    talloc_free (parent_path);
+  DONE:
+    if (db_path != path)
+       free ((char *) db_path);
 
     if (status)
-       *parent_id = -1;
+       *directory_id = -1;
 
     return status;
 }
 
+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.
+ */
+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.
  *
  * The return value will be a pointer to the originl path contents,
@@ -736,8 +819,9 @@ notmuch_database_set_directory_mtime (notmuch_database_t *notmuch,
     unsigned int doc_id;
     notmuch_private_status_t status;
     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
-    const char *db_path = NULL;
+    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");
@@ -756,23 +840,20 @@ notmuch_database_set_directory_mtime (notmuch_database_t *notmuch,
                       Xapian::sortable_serialise (mtime));
 
        if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
-           char *term = talloc_asprintf (NULL, "%s%s",
+           char *term = talloc_asprintf (local, "%s%s",
                                          _find_prefix ("directory"), db_path);
            doc.add_term (term);
-           talloc_free (term);
 
            doc.set_data (path);
 
-           ret = _notmuch_database_find_parent_id (notmuch, path,
-                                                   &parent_id);
-           if (ret)
-               return ret;
+           _notmuch_database_split_path (local, path, &parent, NULL);
+
+           _notmuch_database_find_directory_id (notmuch, parent, &parent_id);
 
-           term = talloc_asprintf (NULL, "%s%u",
+           term = talloc_asprintf (local, "%s%u",
                                    _find_prefix ("parent"),
                                    parent_id);
            doc.add_term (term);
-           talloc_free (term);
 
            db->add_document (doc);
        } else {
@@ -789,6 +870,8 @@ notmuch_database_set_directory_mtime (notmuch_database_t *notmuch,
     if (db_path != path)
        free ((char *) db_path);
 
+    talloc_free (local);
+
     return ret;
 }
 
@@ -1145,23 +1228,24 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
            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) {