[Storage] Implement Key API

1 files changed, 153 insertions, 3 deletions

diff --git a/common/storage.h b/common/storage.h
index a8c486c..3cc5adf 100644
--- a/common/storage.h
+++ b/common/storage.h
@@ -22,8 +22,10 @@
 #pragma once
 
 #include "sink_export.h"
+#include "utils.h"
 #include <string>
 #include <functional>
+#include <QUuid>
 #include <QString>
 #include <QMap>
 
@@ -38,6 +40,151 @@ struct SINK_EXPORT DbLayout {
     Databases tables;
 };
 
+class Identifier
+{
+public:
+    // RFC 4122 Section 4.1.2 says 128 bits -> 16 bytes
+    static const constexpr size_t INTERNAL_REPR_SIZE = 16;
+    static const constexpr size_t DISPLAY_REPR_SIZE = 38;
+
+    Identifier() : uid(QUuid::createUuid()) {};
+
+    QByteArray toInternalByteArray() const
+    {
+        return uid.toRfc4122();
+    }
+
+    static Identifier fromInternalByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == INTERNAL_REPR_SIZE);
+        return Identifier(QUuid::fromRfc4122(bytes));
+    }
+
+    QString toDisplayString() const
+    {
+        return uid.toString();
+    }
+
+    QByteArray toDisplayByteArray() const
+    {
+        return uid.toByteArray();
+    }
+
+    static Identifier fromDisplayByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == DISPLAY_REPR_SIZE);
+        return Identifier(QUuid::fromString(QString::fromUtf8(bytes)));
+    }
+
+private:
+    explicit Identifier(const QUuid &uid) : uid(uid) {}
+    QUuid uid;
+};
+
+class Revision
+{
+public:
+    // qint64 has a 19 digit decimal representation
+    static const constexpr size_t INTERNAL_REPR_SIZE = 19;
+    static const constexpr size_t DISPLAY_REPR_SIZE = 19;
+
+    Revision(qint64 rev) : rev(rev) {}
+
+    QByteArray toInternalByteArray() const
+    {
+        return padNumber(rev);
+    }
+
+    static Revision fromInternalByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == INTERNAL_REPR_SIZE);
+        return Revision(bytes.toLongLong());
+    }
+
+    QString toDisplayString() const
+    {
+        return QString::fromUtf8(toInternalByteArray());
+    }
+
+    QByteArray toDisplayByteArray() const
+    {
+        return toInternalByteArray();
+    }
+
+    static Revision fromDisplayByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == DISPLAY_REPR_SIZE);
+        return fromInternalByteArray(bytes);
+    }
+
+    qint64 toQint64() const
+    {
+        return rev;
+    }
+
+private:
+    qint64 rev;
+};
+
+class Key
+{
+public:
+    static const constexpr size_t INTERNAL_REPR_SIZE = Identifier::INTERNAL_REPR_SIZE + Revision::INTERNAL_REPR_SIZE;
+    static const constexpr size_t DISPLAY_REPR_SIZE = Identifier::DISPLAY_REPR_SIZE + Revision::DISPLAY_REPR_SIZE;
+
+    Key(const Identifier &id, const Revision &rev) : id(id), rev(rev) {}
+
+    QByteArray toInternalByteArray() const
+    {
+        return id.toInternalByteArray() + rev.toInternalByteArray();
+    }
+
+    static Key fromInternalByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == INTERNAL_REPR_SIZE);
+        auto idBytes = bytes.mid(0, Identifier::INTERNAL_REPR_SIZE);
+        auto revBytes = bytes.mid(Identifier::INTERNAL_REPR_SIZE);
+        return Key(Identifier::fromInternalByteArray(idBytes), Revision::fromInternalByteArray(revBytes));
+    }
+
+    QString toDisplayString() const
+    {
+        return id.toDisplayString() + rev.toDisplayString();
+    }
+
+    QByteArray toDisplayByteArray() const
+    {
+        return id.toDisplayByteArray() + rev.toDisplayByteArray();
+    }
+
+    static Key fromDisplayByteArray(const QByteArray &bytes)
+    {
+        Q_ASSERT(bytes.size() == DISPLAY_REPR_SIZE);
+        auto idBytes = bytes.mid(0, Identifier::DISPLAY_REPR_SIZE);
+        auto revBytes = bytes.mid(Identifier::DISPLAY_REPR_SIZE);
+        return Key(Identifier::fromDisplayByteArray(idBytes), Revision::fromDisplayByteArray(revBytes));
+    }
+
+    const Identifier &identifier() const
+    {
+        return id;
+    }
+
+    const Revision &revision() const
+    {
+        return rev;
+    }
+
+    void setRevision(const Revision &newRev)
+    {
+        rev = newRev;
+    }
+
+private:
+    Identifier id;
+    Revision rev;
+};
+
 class SINK_EXPORT DataStore
 {
 public:
@@ -237,9 +384,9 @@ public:
     static bool isInternalKey(void *key, int keySize);
     static bool isInternalKey(const QByteArray &key);
 
-    static QByteArray assembleKey(const QByteArray &key, qint64 revision);
-    static QByteArray uidFromKey(const QByteArray &key);
-    static qint64 revisionFromKey(const QByteArray &key);
+    //static QByteArray assembleKey(const QByteArray &key, qint64 revision);
+    //static Identifier uidFromKey(const QByteArray &key);
+    //static qint64 revisionFromKey(const QByteArray &key);
 
     static NamedDatabase mainDatabase(const Transaction &, const QByteArray &type);
 
@@ -260,3 +407,6 @@ private:
 } // namespace Sink
 
 SINK_EXPORT QDebug& operator<<(QDebug &dbg, const Sink::Storage::DataStore::Error &error);
+SINK_EXPORT QDebug& operator<<(QDebug &dbg, const Sink::Storage::Identifier &);
+SINK_EXPORT QDebug& operator<<(QDebug &dbg, const Sink::Storage::Revision &);
+SINK_EXPORT QDebug& operator<<(QDebug &dbg, const Sink::Storage::Key &);