Changeset 11369

Timestamp:

2008-09-05 10:57:26 (3 months ago)

Author:

richard

Message:

include/xapian/database.h,api/omdatabase.cc: Add
Database.get_uuid() which returns a unique identifier for the
database.
tests/api_anydb.cc: Add test uuid1 to test basic get_uuid()
behaviour.
common/database.h: Extend documentation comment for get_uuid() a
bit.
backends/remote/remote-database.cc,common/remote-database.h,
net/remoteserver.cc: Add support for get_uuid() to remote
databases.

Location:

trunk/xapian-core

Files:

• ChangeLog (modified) (1 diff)
• api/omdatabase.cc (modified) (1 diff)
• backends/remote/remote-database.cc (modified) (3 diffs)
• common/database.h (modified) (1 diff)
• common/remote-database.h (modified) (2 diffs)
• include/xapian/database.h (modified) (1 diff)
• net/remoteserver.cc (modified) (2 diffs)
• tests/api_anydb.cc (modified) (1 diff)

trunk/xapian-core/ChangeLog

@@ +1 @@
+Fri Sep 05 09:38:35 GMT 2008  Richard Boulton <richard@lemurconsulting.com>
+
+        * include/xapian/database.h,api/omdatabase.cc: Add
+          Database.get_uuid() which returns a unique identifier for the
+          database.
+        * tests/api_anydb.cc: Add test uuid1 to test basic get_uuid()
+          behaviour.
+        * common/database.h: Extend documentation comment for get_uuid() a
+          bit.
+        * backends/remote/remote-database.cc,common/remote-database.h,
+          net/remoteserver.cc: Add support for get_uuid() to remote
+          databases.
+
 Thu Sep 04 11:37:54 GMT 2008  Richard Boulton <richard@lemurconsulting.com>
 

trunk/xapian-core/api/omdatabase.cc

@@ -556 +556 @@
 }
 
+std::string
+Database::get_uuid() const
+{
+    DEBUGAPICALL(std::string, "Database::get_uuid", "");
+    if (internal.size() != 1) {
+        if (internal.size() == 0) {
+            throw InvalidOperationError(
+                "UUIDs not supported for uninitialised databases");
+        }
+
+        // FIXME - we could probably make a uuid for each multidatabase
+        // combination by hashing together the uuids for the subdatabases.
+        throw UnimplementedError(
+            "UUIDs not supported for multiple databases");
+    }
+    RETURN(internal[0]->get_uuid());
+}
+
 ///////////////////////////////////////////////////////////////////////////
 

trunk/xapian-core/backends/remote/remote-database.cc

@@ -110 +110 @@
     has_positional_info = (*p++ == '1');
     avlength = unserialise_double(&p, p_end);
+    size_t len = decode_length(&p, p_end, true);
+    uuid = string(p, len);
+    p += len;
     if (p != p_end || avlength < 0) {
         throw Xapian::NetworkError("Bad greeting message received (double)", context);
@@ -315 +318 @@
     has_positional_info = (*p++ == '1');
     avlength = unserialise_double(&p, p_end);
+    size_t len = decode_length(&p, p_end, true);
+    uuid = string(p, len);
+    p += len;
     if (p != p_end || avlength < 0) {
         throw Xapian::NetworkError("Bad REPLY_UPDATE message received", context);
@@ -647 +653 @@
     return decode_length(&p, p_end, false);
 }
+
+string
+RemoteDatabase::get_uuid() const
+{
+    if (uuid.empty())
+        throw Xapian::UnimplementedError(
+            "UUIDs not supported for this database");
+    return uuid;
+}

trunk/xapian-core/common/database.h

@@ -473 +473 @@
         /** Get a UUID for the database.
          *
+         *  The UUID will persist for the lifetime of the database.
+         *
          *  Replicas (eg, made with the replication protocol, or by copying all
          *  the database files) will have the same UUID.  However, copies (made
          *  with copydatabase, or xapian-compact) will have different UUIDs.
+         *
+         *  If the backend does not support UUIDs, or this database has
+         *  multiple sub-databases, an exception will be raised.
          */
         virtual string get_uuid() const;

trunk/xapian-core/common/remote-database.h

@@ -65 +65 @@
     /// Has positional information?
     mutable bool has_positional_info;
+
+    /// The UUID of the remote database.
+    mutable string uuid;
 
     /// The context to return with any error messages
@@ -218 +221 @@
     Xapian::docid replace_document(const std::string & unique_term,
                                    const Xapian::Document & document);
+
+    std::string get_uuid() const;
 };
 

trunk/xapian-core/include/xapian/database.h

@@ -363 +363 @@
             return Xapian::TermIterator(NULL);
         }
+
+        /** Get a UUID for the database.
+         *
+         *  The UUID will persist for the lifetime of the database.
+         *
+         *  Replicas (eg, made with the replication protocol, or by copying all
+         *  the database files) will have the same UUID.  However, copies (made
+         *  with copydatabase, or xapian-compact) will have different UUIDs.
+         *
+         *  If the backend does not support UUIDs, or this database has
+         *  multiple sub-databases, an exception will be raised.
+         */
+        std::string get_uuid() const;
 };
 

trunk/xapian-core/net/remoteserver.cc

@@ -97 +97 @@
     message += (db->has_positions() ? '1' : '0');
     message += serialise_double(db->get_avlength());
+    string uuid;
+    try {
+        uuid = db->get_uuid();
+    } catch (const Xapian::UnimplementedError &err) {
+        // Leave the uuid empty.
+    }
+    message += encode_length(uuid.size());
+    message += uuid;
     send_message(REPLY_GREETING, message);
 
@@ -338 +346 @@
     message += (db->has_positions() ? '1' : '0');
     message += serialise_double(db->get_avlength());
+    string uuid;
+    try {
+        uuid = db->get_uuid();
+    } catch (const Xapian::UnimplementedError &err) {
+        // Leave the uuid empty.
+    }
+    message += encode_length(uuid.size());
+    message += uuid;
     send_message(REPLY_UPDATE, message);
 }

trunk/xapian-core/tests/api_anydb.cc

@@ -2248 +2248 @@
     return true;
 }
+
+// Feature test for get_uuid.
+DEFINE_TESTCASE(uuid1, backend && !multi) {
+    SKIP_TEST_FOR_BACKEND("inmemory");
+    Xapian::Database db = get_database("apitest_simpledata");
+    std::string uuid1 = db.get_uuid();
+
+    Xapian::Database db2;
+    TEST_EXCEPTION(Xapian::InvalidOperationError, db2.get_uuid());
+
+    db2.add_database(db);
+    TEST_EQUAL(uuid1, db2.get_uuid());
+
+    db2.add_database(db);
+    TEST_EXCEPTION(Xapian::UnimplementedError, db2.get_uuid());
+
+    return true;
+}