X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fprotocol.h;h=053ab29b83c8b5779c6841c576ed0820c26b34a6;hp=121f4e45e778b63315e56375b2e1ad97d2b62e00;hb=9e21879f361dfe9978fb5159664cae352301064b;hpb=fd25e92f19d6afd4eb02844bcbf20ba132868303

diff --git a/src/common/protocol.h b/src/common/protocol.h
index 121f4e45..053ab29b 100644
--- a/src/common/protocol.h
+++ b/src/common/protocol.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2013 by the Quassel Project                        *
+ *   Copyright (C) 2005-2014 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -27,112 +27,207 @@
 
 namespace Protocol {
 
+const quint32 magic = 0x42b33f00;
+
+enum Type {
+    LegacyProtocol = 0x01,
+    DataStreamProtocol = 0x02
+};
+
+
+enum Feature {
+    Encryption = 0x01,
+    Compression = 0x02
+};
+
+
 enum Handler {
-    SignalProxy
+    SignalProxy,
+    AuthHandler
 };
 
 
-/*** handled by SignalProxy ***/
+/*** Handshake, handled by AuthHandler ***/
 
-class SyncMessage
+struct HandshakeMessage {
+    inline Handler handler() const { return AuthHandler; }
+};
+
+
+struct RegisterClient : public HandshakeMessage
 {
-public:
-    inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList &params)
-    : _className(className), _objectName(objectName), _slotName(slotName), _params(params) {}
+    inline RegisterClient(const QString &clientVersion, const QString &buildDate, bool sslSupported = false)
+    : clientVersion(clientVersion)
+    , buildDate(buildDate)
+    , sslSupported(sslSupported) {}
 
-    inline Handler handler() const { return SignalProxy; }
+    QString clientVersion;
+    QString buildDate;
+
+    // this is only used by the LegacyProtocol in compat mode
+    bool sslSupported;
+};
 
-    inline QByteArray className() const { return _className; }
-    inline QString objectName() const { return _objectName; }
-    inline QByteArray slotName() const { return _slotName; }
 
-    inline QVariantList params() const { return _params; }
+struct ClientDenied : public HandshakeMessage
+{
+    inline ClientDenied(const QString &errorString)
+    : errorString(errorString) {}
 
-private:
-    QByteArray _className;
-    QString _objectName;
-    QByteArray _slotName;
-    QVariantList _params;
+    QString errorString;
 };
 
 
-class RpcCall
+struct ClientRegistered : public HandshakeMessage
 {
-public:
-    inline RpcCall(const QByteArray &slotName, const QVariantList &params)
-    : _slotName(slotName), _params(params) {}
+    inline ClientRegistered(quint32 coreFeatures, bool coreConfigured, const QVariantList &backendInfo, bool sslSupported, const QDateTime &coreStartTime)
+    : coreFeatures(coreFeatures)
+    , coreConfigured(coreConfigured)
+    , backendInfo(backendInfo)
+    , sslSupported(sslSupported)
+    , coreStartTime(coreStartTime)
+    {}
+
+    quint32 coreFeatures;
+    bool coreConfigured;
+    QVariantList backendInfo; // TODO: abstract this better
+
+    // this is only used by the LegacyProtocol in compat mode
+    bool sslSupported;
+    QDateTime coreStartTime;
+};
 
-    inline Handler handler() const { return SignalProxy; }
 
-    inline QByteArray slotName() const { return _slotName; }
-    inline QVariantList params() const { return _params; }
+struct SetupData : public HandshakeMessage
+{
+    inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
+    : adminUser(adminUser), adminPassword(adminPassword), backend(backend), setupData(setupData) {}
 
-private:
-    QByteArray _slotName;
-    QVariantList _params;
+    QString adminUser;
+    QString adminPassword;
+    QString backend;
+    QVariantMap setupData;
 };
 
 
-class InitRequest
+struct SetupFailed : public HandshakeMessage
 {
-public:
-    inline InitRequest(const QByteArray &className, const QString &objectName)
-    : _className(className), _objectName(objectName) {}
+    inline SetupFailed(const QString &errorString)
+    : errorString(errorString) {}
 
-    inline Handler handler() const { return SignalProxy; }
+    QString errorString;
+};
 
-    inline QByteArray className() const { return _className; }
-    inline QString objectName() const { return _objectName; }
 
-private:
-    QByteArray _className;
-    QString _objectName;
+struct SetupDone : public HandshakeMessage
+{
+    inline SetupDone() {}
 };
 
 
-class InitData
+struct Login : public HandshakeMessage
 {
-public:
-    inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
-    : _className(className), _objectName(objectName), _initData(initData) {}
+    inline Login(const QString &user, const QString &password)
+    : user(user), password(password) {}
+
+    QString user;
+    QString password;
+};
+
+
+struct LoginFailed : public HandshakeMessage
+{
+    inline LoginFailed(const QString &errorString)
+    : errorString(errorString) {}
+
+    QString errorString;
+};
+
 
+struct LoginSuccess : public HandshakeMessage
+{
+    inline LoginSuccess() {}
+};
+
+
+// TODO: more generic format
+struct SessionState : public HandshakeMessage
+{
+    inline SessionState() {} // needed for QMetaType (for the mono client)
+    inline SessionState(const QVariantList &identities, const QVariantList &bufferInfos, const QVariantList &networkIds)
+    : identities(identities), bufferInfos(bufferInfos), networkIds(networkIds) {}
+
+    QVariantList identities;
+    QVariantList bufferInfos;
+    QVariantList networkIds;
+};
+
+/*** handled by SignalProxy ***/
+
+struct SignalProxyMessage
+{
     inline Handler handler() const { return SignalProxy; }
+};
 
-    inline QByteArray className() const { return _className; }
-    inline QString objectName() const { return _objectName; }
 
-    inline QVariantMap initData() const { return _initData; }
+struct SyncMessage : public SignalProxyMessage
+{
+    inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList &params)
+    : className(className), objectName(objectName), slotName(slotName), params(params) {}
 
-private:
-    QByteArray _className;
-    QString _objectName;
-    QVariantMap _initData;
+    QByteArray className;
+    QString objectName;
+    QByteArray slotName;
+    QVariantList params;
 };
 
 
-/*** handled by RemoteConnection ***/
+struct RpcCall : public SignalProxyMessage
+{
+    inline RpcCall(const QByteArray &slotName, const QVariantList &params)
+    : slotName(slotName), params(params) {}
+
+    QByteArray slotName;
+    QVariantList params;
+};
+
 
-class HeartBeat
+struct InitRequest : public SignalProxyMessage
 {
-public:
-    inline HeartBeat(const QDateTime &timestamp) : _timestamp(timestamp) {}
+    inline InitRequest(const QByteArray &className, const QString &objectName)
+    : className(className), objectName(objectName) {}
+
+    QByteArray className;
+    QString objectName;
+};
+
 
-    inline QDateTime timestamp() const { return _timestamp; }
+struct InitData : public SignalProxyMessage
+{
+    inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
+    : className(className), objectName(objectName), initData(initData) {}
 
-private:
-    QDateTime _timestamp;
+    QByteArray className;
+    QString objectName;
+    QVariantMap initData;
 };
 
 
-class HeartBeatReply
+/*** handled by RemoteConnection ***/
+
+struct HeartBeat
 {
-public:
-    inline HeartBeatReply(const QDateTime &timestamp) : _timestamp(timestamp) {}
+    inline HeartBeat(const QDateTime &timestamp) : timestamp(timestamp) {}
 
-    inline QDateTime timestamp() const { return _timestamp; }
+    QDateTime timestamp;
+};
+
+
+struct HeartBeatReply
+{
+    inline HeartBeatReply(const QDateTime &timestamp) : timestamp(timestamp) {}
 
-private:
-    QDateTime _timestamp;
+    QDateTime timestamp;
 };