1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
26 #include <QVariantList>
30 const quint32 magic = 0x42b33f00;
33 InternalProtocol = 0x00,
34 LegacyProtocol = 0x01,
35 DataStreamProtocol = 0x02
51 /*** Handshake, handled by AuthHandler ***/
53 struct HandshakeMessage {
54 inline Handler handler() const { return AuthHandler; }
58 struct RegisterClient : public HandshakeMessage
60 inline RegisterClient(const QString &clientVersion, const QString &buildDate, bool sslSupported = false)
61 : clientVersion(clientVersion)
62 , buildDate(buildDate)
63 , sslSupported(sslSupported) {}
65 QString clientVersion;
68 // this is only used by the LegacyProtocol in compat mode
73 struct ClientDenied : public HandshakeMessage
75 inline ClientDenied(const QString &errorString)
76 : errorString(errorString) {}
82 struct ClientRegistered : public HandshakeMessage
84 inline ClientRegistered(quint32 coreFeatures, bool coreConfigured, const QVariantList &backendInfo, const QVariantList &authBackendInfo, bool sslSupported)
85 : coreFeatures(coreFeatures)
86 , coreConfigured(coreConfigured)
87 , backendInfo(backendInfo)
88 , authBackendInfo(authBackendInfo)
89 , sslSupported(sslSupported)
95 // The authBackendInfo should be optional!
96 QVariantList backendInfo; // TODO: abstract this better
97 QVariantList authBackendInfo;
99 // this is only used by the LegacyProtocol in compat mode
104 struct SetupData : public HandshakeMessage
106 inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend, const QString &authenticator, const QVariantMap &setupData, const QVariantMap &authSetupData)
107 : adminUser(adminUser), adminPassword(adminPassword), backend(backend), authenticator(authenticator), setupData(setupData), authSetupData(authSetupData) {}
110 QString adminPassword;
112 QString authenticator;
113 QVariantMap setupData;
114 QVariantMap authSetupData;
118 struct SetupFailed : public HandshakeMessage
120 inline SetupFailed(const QString &errorString)
121 : errorString(errorString) {}
127 struct SetupDone : public HandshakeMessage
129 inline SetupDone() {}
133 struct Login : public HandshakeMessage
135 inline Login(const QString &user, const QString &password)
136 : user(user), password(password) {}
143 struct LoginFailed : public HandshakeMessage
145 inline LoginFailed(const QString &errorString)
146 : errorString(errorString) {}
152 struct LoginSuccess : public HandshakeMessage
154 inline LoginSuccess() {}
158 // TODO: more generic format
159 struct SessionState : public HandshakeMessage
161 inline SessionState() {} // needed for QMetaType (for the mono client)
162 inline SessionState(const QVariantList &identities, const QVariantList &bufferInfos, const QVariantList &networkIds)
163 : identities(identities), bufferInfos(bufferInfos), networkIds(networkIds) {}
165 QVariantList identities;
166 QVariantList bufferInfos;
167 QVariantList networkIds;
170 /*** handled by SignalProxy ***/
172 struct SignalProxyMessage
174 inline Handler handler() const { return SignalProxy; }
178 struct SyncMessage : public SignalProxyMessage
180 inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList ¶ms)
181 : className(className), objectName(objectName), slotName(slotName), params(params) {}
183 QByteArray className;
190 struct RpcCall : public SignalProxyMessage
192 inline RpcCall(const QByteArray &slotName, const QVariantList ¶ms)
193 : slotName(slotName), params(params) {}
200 struct InitRequest : public SignalProxyMessage
202 inline InitRequest(const QByteArray &className, const QString &objectName)
203 : className(className), objectName(objectName) {}
205 QByteArray className;
210 struct InitData : public SignalProxyMessage
212 inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
213 : className(className), objectName(objectName), initData(initData) {}
215 QByteArray className;
217 QVariantMap initData;
221 /*** handled by RemoteConnection ***/
225 inline HeartBeat(const QDateTime ×tamp) : timestamp(timestamp) {}
231 struct HeartBeatReply
233 inline HeartBeatReply(const QDateTime ×tamp) : timestamp(timestamp) {}