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 ***************************************************************************/
25 #include <QVariantList>
29 const quint32 magic = 0x42b33f00;
32 InternalProtocol = 0x00,
33 LegacyProtocol = 0x01,
34 DataStreamProtocol = 0x02
50 /*** Handshake, handled by AuthHandler ***/
52 struct HandshakeMessage {
53 inline Handler handler() const { return Handler::AuthHandler; }
57 struct RegisterClient : public HandshakeMessage
59 inline RegisterClient(const QString &clientVersion, const QString &buildDate, bool sslSupported = false, quint32 features = 0)
60 : clientVersion(clientVersion)
61 , buildDate(buildDate)
62 , sslSupported(sslSupported)
63 , clientFeatures(features) {}
65 QString clientVersion;
68 // this is only used by the LegacyProtocol in compat mode
70 quint32 clientFeatures;
74 struct ClientDenied : public HandshakeMessage
76 inline ClientDenied(const QString &errorString)
77 : errorString(errorString) {}
83 struct ClientRegistered : public HandshakeMessage
85 inline ClientRegistered(quint32 coreFeatures, bool coreConfigured, const QVariantList &backendInfo, bool sslSupported, const QVariantList &authenticatorInfo)
86 : coreFeatures(coreFeatures)
87 , coreConfigured(coreConfigured)
88 , backendInfo(backendInfo)
89 , authenticatorInfo(authenticatorInfo)
90 , sslSupported(sslSupported)
96 // The authenticatorInfo should be optional!
97 QVariantList backendInfo; // TODO: abstract this better
98 QVariantList authenticatorInfo;
100 // this is only used by the LegacyProtocol in compat mode
105 struct SetupData : public HandshakeMessage
107 inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend,
108 const QVariantMap &setupData, const QString &authenticator = QString(),
109 const QVariantMap &authSetupData = QVariantMap())
110 : adminUser(adminUser)
111 , adminPassword(adminPassword)
113 , setupData(setupData)
114 , authenticator(authenticator)
115 , authSetupData(authSetupData)
119 QString adminPassword;
121 QVariantMap setupData;
122 QString authenticator;
123 QVariantMap authSetupData;
127 struct SetupFailed : public HandshakeMessage
129 inline SetupFailed(const QString &errorString)
130 : errorString(errorString) {}
136 struct SetupDone : public HandshakeMessage
138 inline SetupDone() {}
142 struct Login : public HandshakeMessage
144 inline Login(const QString &user, const QString &password)
145 : user(user), password(password) {}
152 struct LoginFailed : public HandshakeMessage
154 inline LoginFailed(const QString &errorString)
155 : errorString(errorString) {}
161 struct LoginSuccess : public HandshakeMessage
163 inline LoginSuccess() {}
167 // TODO: more generic format
168 struct SessionState : public HandshakeMessage
170 inline SessionState() {} // needed for QMetaType (for the mono client)
171 inline SessionState(const QVariantList &identities, const QVariantList &bufferInfos, const QVariantList &networkIds)
172 : identities(identities), bufferInfos(bufferInfos), networkIds(networkIds) {}
174 QVariantList identities;
175 QVariantList bufferInfos;
176 QVariantList networkIds;
179 /*** handled by SignalProxy ***/
181 struct SignalProxyMessage
183 inline Handler handler() const { return Handler::SignalProxy; }
187 struct SyncMessage : public SignalProxyMessage
189 inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList ¶ms)
190 : className(className), objectName(objectName), slotName(slotName), params(params) {}
192 QByteArray className;
199 struct RpcCall : public SignalProxyMessage
201 inline RpcCall(const QByteArray &slotName, const QVariantList ¶ms)
202 : slotName(slotName), params(params) {}
209 struct InitRequest : public SignalProxyMessage
211 inline InitRequest(const QByteArray &className, const QString &objectName)
212 : className(className), objectName(objectName) {}
214 QByteArray className;
219 struct InitData : public SignalProxyMessage
221 inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
222 : className(className), objectName(objectName), initData(initData) {}
224 QByteArray className;
226 QVariantMap initData;
230 /*** handled by RemoteConnection ***/
234 inline HeartBeat(const QDateTime ×tamp) : timestamp(timestamp) {}
240 struct HeartBeatReply
242 inline HeartBeatReply(const QDateTime ×tamp) : timestamp(timestamp) {}