Cockatrice 2025-11-30-Development-2.11.0-beta.38
A cross-platform virtual tabletop for multiplayer card games
Loading...
Searching...
No Matches
serversocketinterface.h
Go to the documentation of this file.
1/***************************************************************************
2 * Copyright (C) 2008 by Max-Wilhelm Bruker *
3 * brukie@laptop *
4 * *
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) any later version. *
9 * *
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. *
14 * *
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20#ifndef SERVERSOCKETINTERFACE_H
21#define SERVERSOCKETINTERFACE_H
22
23#include <QHostAddress>
24#include <QMutex>
25#include <QTcpSocket>
26#include <QWebSocket>
28
29class Servatrice;
31class DeckList;
32class ServerInfo_DeckStorage_Folder;
33
34class Command_AddToList;
35class Command_RemoveFromList;
36class Command_DeckList;
37class Command_DeckNewDir;
38class Command_DeckDelDir;
39class Command_DeckDel;
40class Command_DeckDownload;
41class Command_DeckUpload;
42class Command_ReplayList;
43class Command_ReplayDownload;
44class Command_ReplayModifyMatch;
45class Command_ReplayDeleteMatch;
46class Command_ReplayGetCode;
47class Command_ReplaySubmitCode;
48
49class Command_BanFromServer;
50class Command_UpdateServerMessage;
51class Command_ShutdownServer;
52class Command_ReloadConfig;
53
54class Command_AccountEdit;
55class Command_AccountImage;
56class Command_AccountPassword;
57
59{
60 Q_OBJECT
61protected slots:
62 void catchSocketError(QAbstractSocket::SocketError socketError);
64 virtual void flushOutputQueue() = 0;
65signals:
67 void incTxBytes(qint64 amount);
68
69protected:
70 void logDebugMessage(const QString &message);
71 bool tooManyRegistrationAttempts(const QString &ipAddress);
72
73 virtual void writeToSocket(QByteArray &data) = 0;
74 virtual void flushSocket() = 0;
75
77 QList<ServerMessage> outputQueue;
79
80private:
82
83 Response::ResponseCode cmdAddToList(const Command_AddToList &cmd, ResponseContainer &rc);
84 Response::ResponseCode cmdRemoveFromList(const Command_RemoveFromList &cmd, ResponseContainer &rc);
85 int getDeckPathId(int basePathId, QStringList path);
86 int getDeckPathId(const QString &path);
87 bool deckListHelper(int folderId, ServerInfo_DeckStorage_Folder *folder);
88 Response::ResponseCode cmdDeckList(const Command_DeckList &cmd, ResponseContainer &rc);
89 Response::ResponseCode cmdDeckNewDir(const Command_DeckNewDir &cmd, ResponseContainer &rc);
90 void deckDelDirHelper(int basePathId);
91 void sendServerMessage(const QString userName, const QString message);
92 Response::ResponseCode cmdDeckDelDir(const Command_DeckDelDir &cmd, ResponseContainer &rc);
93 Response::ResponseCode cmdDeckDel(const Command_DeckDel &cmd, ResponseContainer &rc);
94 Response::ResponseCode cmdDeckUpload(const Command_DeckUpload &cmd, ResponseContainer &rc);
96 Response::ResponseCode cmdDeckDownload(const Command_DeckDownload &cmd, ResponseContainer &rc);
97 Response::ResponseCode cmdReplayList(const Command_ReplayList &cmd, ResponseContainer &rc);
98 Response::ResponseCode cmdReplayDownload(const Command_ReplayDownload &cmd, ResponseContainer &rc);
99 Response::ResponseCode cmdReplayModifyMatch(const Command_ReplayModifyMatch &cmd, ResponseContainer &rc);
100 Response::ResponseCode cmdReplayDeleteMatch(const Command_ReplayDeleteMatch &cmd, ResponseContainer &rc);
101 QString createHashForReplay(int gameId);
102 Response::ResponseCode cmdReplayGetCode(const Command_ReplayGetCode &cmd, ResponseContainer &rc);
103 Response::ResponseCode cmdReplaySubmitCode(const Command_ReplaySubmitCode &cmd, ResponseContainer &rc);
104 Response::ResponseCode cmdBanFromServer(const Command_BanFromServer &cmd, ResponseContainer &rc);
105 Response::ResponseCode cmdWarnUser(const Command_WarnUser &cmd, ResponseContainer &rc);
106 Response::ResponseCode cmdGetLogHistory(const Command_ViewLogHistory &cmd, ResponseContainer &rc);
107 Response::ResponseCode cmdGetBanHistory(const Command_GetBanHistory &cmd, ResponseContainer &rc);
108 Response::ResponseCode cmdGetWarnList(const Command_GetWarnList &cmd, ResponseContainer &rc);
109 Response::ResponseCode cmdGetWarnHistory(const Command_GetWarnHistory &cmd, ResponseContainer &rc);
110 Response::ResponseCode cmdShutdownServer(const Command_ShutdownServer &cmd, ResponseContainer &rc);
111 Response::ResponseCode cmdUpdateServerMessage(const Command_UpdateServerMessage &cmd, ResponseContainer &rc);
112 Response::ResponseCode cmdRegisterAccount(const Command_Register &cmd, ResponseContainer &rc);
113 Response::ResponseCode cmdActivateAccount(const Command_Activate &cmd, ResponseContainer & /* rc */);
114 Response::ResponseCode cmdReloadConfig(const Command_ReloadConfig & /* cmd */, ResponseContainer & /*rc*/);
115 Response::ResponseCode cmdAdjustMod(const Command_AdjustMod &cmd, ResponseContainer & /*rc*/);
116 Response::ResponseCode cmdForgotPasswordRequest(const Command_ForgotPasswordRequest &cmd, ResponseContainer &rc);
117 Response::ResponseCode continuePasswordRequest(const QString &userName,
118 const QString &clientId,
120 bool challenged = false);
121 Response::ResponseCode cmdForgotPasswordReset(const Command_ForgotPasswordReset &cmd, ResponseContainer &rc);
122 Response::ResponseCode cmdForgotPasswordChallenge(const Command_ForgotPasswordChallenge &cmd,
124 Response::ResponseCode cmdRequestPasswordSalt(const Command_RequestPasswordSalt &cmd, ResponseContainer &rc);
125 Response::ResponseCode processExtendedSessionCommand(int cmdType, const SessionCommand &cmd, ResponseContainer &rc);
126 Response::ResponseCode
127 processExtendedModeratorCommand(int cmdType, const ModeratorCommand &cmd, ResponseContainer &rc);
128 Response::ResponseCode processExtendedAdminCommand(int cmdType, const AdminCommand &cmd, ResponseContainer &rc);
129
130 Response::ResponseCode cmdAccountEdit(const Command_AccountEdit &cmd, ResponseContainer &rc);
131 Response::ResponseCode cmdAccountImage(const Command_AccountImage &cmd, ResponseContainer &rc);
132 Response::ResponseCode cmdAccountPassword(const Command_AccountPassword &cmd, ResponseContainer &rc);
133 Response::ResponseCode cmdGrantReplayAccess(const Command_GrantReplayAccess &cmd, ResponseContainer &rc);
134 Response::ResponseCode cmdForceActivateUser(const Command_ForceActivateUser &cmd, ResponseContainer &rc);
135
136 Response::ResponseCode cmdGetAdminNotes(const Command_GetAdminNotes &cmd, ResponseContainer &rc);
137 Response::ResponseCode cmdUpdateAdminNotes(const Command_UpdateAdminNotes &cmd, ResponseContainer &rc);
138
139 bool addAdminFlagToUser(const QString &user, int flag);
140 bool removeAdminFlagFromUser(const QString &user, int flag);
141
142 bool isPasswordLongEnough(const int passwordLength);
143 void removeSaidMessages(const QString &userName, int amount);
144
145public:
147 Servatrice_DatabaseInterface *_databaseInterface,
148 QObject *parent = 0);
152 bool initSession();
153
154 virtual QHostAddress getPeerAddress() const = 0;
155 virtual QString getAddress() const = 0;
156
157 void transmitProtocolItem(const ServerMessage &item);
158};
159
161{
162 Q_OBJECT
163public:
165 Servatrice_DatabaseInterface *_databaseInterface,
166 QObject *parent = 0);
168
169 QHostAddress getPeerAddress() const
170 {
171 return socket->peerAddress();
172 }
173 QString getAddress() const
174 {
175 return socket->peerAddress().toString();
176 }
177 QString getConnectionType() const
178 {
179 return "tcp";
180 }
181
182private:
183 QTcpSocket *socket;
184 QByteArray inputBuffer;
188
189protected:
190 void writeToSocket(QByteArray &data)
191 {
192 socket->write(data);
193 }
195 {
196 socket->flush();
197 }
199 bool initTcpSession();
200protected slots:
201 void readClient();
202 void flushOutputQueue();
203public slots:
204 void initConnection(int socketDescriptor);
205};
206
208{
209 Q_OBJECT
210public:
212 Servatrice_DatabaseInterface *_databaseInterface,
213 QObject *parent = nullptr);
215
216 QHostAddress getPeerAddress() const
217 {
218 return address;
219 }
220 QString getAddress() const
221 {
222 return address.toString();
223 }
224 QString getConnectionType() const
225 {
226 return "websocket";
227 }
228
229private:
230 QWebSocket *socket;
231 QHostAddress address;
232
233protected:
234 void writeToSocket(QByteArray &data)
235 {
236 socket->sendBinaryMessage(data);
237 }
239 {
240 socket->flush();
241 }
243protected slots:
244 void binaryMessageReceived(const QByteArray &message);
245 void flushOutputQueue();
246public slots:
247 void initConnection(void *_socket);
248};
249
250#endif
bool isPasswordLongEnough(const int passwordLength)
Definition serversocketinterface.cpp:2235
Response::ResponseCode cmdReplayDeleteMatch(const Command_ReplayDeleteMatch &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:727
Response::ResponseCode cmdRegisterAccount(const Command_Register &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1154
QMutex outputQueueMutex
Definition serversocketinterface.h:78
Response::ResponseCode processExtendedSessionCommand(int cmdType, const SessionCommand &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:157
Response::ResponseCode cmdRequestPasswordSalt(const Command_RequestPasswordSalt &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1673
Response::ResponseCode cmdDeckDownload(const Command_DeckDownload &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:598
Response::ResponseCode cmdGrantReplayAccess(const Command_GrantReplayAccess &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1805
Response::ResponseCode cmdDeckList(const Command_DeckList &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:417
Response::ResponseCode cmdAccountEdit(const Command_AccountEdit &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1368
virtual QString getAddress() const =0
Response::ResponseCode cmdForceActivateUser(const Command_ForceActivateUser &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1851
Response::ResponseCode cmdDeckDel(const Command_DeckDel &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:512
Response::ResponseCode cmdGetAdminNotes(const Command_GetAdminNotes &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1881
Response::ResponseCode cmdShutdownServer(const Command_ShutdownServer &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1703
Response::ResponseCode cmdAddToList(const Command_AddToList &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:266
int getDeckPathId(int basePathId, QStringList path)
Definition serversocketinterface.cpp:345
Response::ResponseCode cmdReplaySubmitCode(const Command_ReplaySubmitCode &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:811
bool tooManyRegistrationAttempts(const QString &ipAddress)
Definition serversocketinterface.cpp:1331
void sendServerMessage(const QString userName, const QString message)
Definition serversocketinterface.cpp:481
Response::ResponseCode cmdGetWarnList(const Command_GetWarnList &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:969
Response::ResponseCode cmdAdjustMod(const Command_AdjustMod &cmd, ResponseContainer &)
Definition serversocketinterface.cpp:1772
virtual void writeToSocket(QByteArray &data)=0
Response::ResponseCode cmdDeckUpload(const Command_DeckUpload &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:533
Response::ResponseCode cmdGetLogHistory(const Command_ViewLogHistory &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:877
Response::ResponseCode cmdUpdateServerMessage(const Command_UpdateServerMessage &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1696
Response::ResponseCode cmdReplayDownload(const Command_ReplayDownload &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:673
Response::ResponseCode cmdDeckNewDir(const Command_DeckNewDir &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:435
Response::ResponseCode processExtendedAdminCommand(int cmdType, const AdminCommand &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:250
void deckDelDirHelper(int basePathId)
Definition serversocketinterface.cpp:462
Response::ResponseCode cmdForgotPasswordChallenge(const Command_ForgotPasswordChallenge &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1632
bool addAdminFlagToUser(const QString &user, int flag)
Definition serversocketinterface.cpp:1720
bool removeAdminFlagFromUser(const QString &user, int flag)
Definition serversocketinterface.cpp:1744
void transmitProtocolItem(const ServerMessage &item)
Definition serversocketinterface.cpp:143
AbstractServerSocketInterface(Servatrice *_server, Servatrice_DatabaseInterface *_databaseInterface, QObject *parent=0)
Definition serversocketinterface.cpp:88
void logDebugMessage(const QString &message)
Definition serversocketinterface.cpp:152
Response::ResponseCode cmdForgotPasswordRequest(const Command_ForgotPasswordRequest &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1499
~AbstractServerSocketInterface()
Definition serversocketinterface.h:149
Response::ResponseCode cmdReloadConfig(const Command_ReloadConfig &, ResponseContainer &)
Definition serversocketinterface.cpp:1711
Response::ResponseCode cmdAccountPassword(const Command_AccountPassword &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1468
void catchSocketDisconnected()
Definition serversocketinterface.cpp:138
Response::ResponseCode cmdReplayGetCode(const Command_ReplayGetCode &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:778
Response::ResponseCode cmdAccountImage(const Command_AccountImage &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1448
Servatrice_DatabaseInterface * sqlInterface
Definition serversocketinterface.h:81
Response::ResponseCode cmdReplayList(const Command_ReplayList &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:619
bool initSession()
Definition serversocketinterface.cpp:100
bool deckListHelper(int folderId, ServerInfo_DeckStorage_Folder *folder)
Definition serversocketinterface.cpp:373
void incTxBytes(qint64 amount)
QString createHashForReplay(int gameId)
Definition serversocketinterface.cpp:756
Response::ResponseCode processExtendedModeratorCommand(int cmdType, const ModeratorCommand &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:219
void removeSaidMessages(const QString &userName, int amount)
Definition serversocketinterface.cpp:1003
Response::ResponseCode cmdDeckDelDir(const Command_DeckDelDir &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:497
Response::ResponseCode cmdGetBanHistory(const Command_GetBanHistory &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:955
QList< ServerMessage > outputQueue
Definition serversocketinterface.h:77
Response::ResponseCode cmdUpdateAdminNotes(const Command_UpdateAdminNotes &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1904
virtual void flushOutputQueue()=0
Response::ResponseCode cmdActivateAccount(const Command_Activate &cmd, ResponseContainer &)
Definition serversocketinterface.cpp:1338
void catchSocketError(QAbstractSocket::SocketError socketError)
Definition serversocketinterface.cpp:131
Response::ResponseCode cmdForgotPasswordReset(const Command_ForgotPasswordReset &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1581
DeckList * getDeckFromDatabase(int deckId)
Response::ResponseCode cmdGetWarnHistory(const Command_GetWarnHistory &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:989
Response::ResponseCode cmdWarnUser(const Command_WarnUser &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1010
Response::ResponseCode continuePasswordRequest(const QString &userName, const QString &clientId, ResponseContainer &rc, bool challenged=false)
Definition serversocketinterface.cpp:1533
Servatrice * servatrice
Definition serversocketinterface.h:76
Response::ResponseCode cmdReplayModifyMatch(const Command_ReplayModifyMatch &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:707
Response::ResponseCode cmdBanFromServer(const Command_BanFromServer &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:1055
virtual QHostAddress getPeerAddress() const =0
virtual void flushSocket()=0
Response::ResponseCode cmdRemoveFromList(const Command_RemoveFromList &cmd, ResponseContainer &rc)
Definition serversocketinterface.cpp:306
Represents a complete deck, including metadata, zones, cards, and sideboard plans.
Definition deck_list.h:127
Definition server_response_containers.h:89
Definition servatrice_database_interface.h:18
Definition servatrice.h:131
Server_ProtocolHandler(Server *_server, Server_DatabaseInterface *_databaseInterface, QObject *parent=0)
Definition server_protocolhandler.cpp:31
TcpServerSocketInterface(Servatrice *_server, Servatrice_DatabaseInterface *_databaseInterface, QObject *parent=0)
Definition serversocketinterface.cpp:1923
QByteArray inputBuffer
Definition serversocketinterface.h:184
QHostAddress getPeerAddress() const
Definition serversocketinterface.h:169
void readClient()
Definition serversocketinterface.cpp:2005
void flushSocket()
Definition serversocketinterface.h:194
void writeToSocket(QByteArray &data)
Definition serversocketinterface.h:190
bool messageInProgress
Definition serversocketinterface.h:185
bool handshakeStarted
Definition serversocketinterface.h:186
QString getConnectionType() const
Definition serversocketinterface.h:177
void initSessionDeprecated()
Definition serversocketinterface.cpp:1960
QString getAddress() const
Definition serversocketinterface.h:173
QTcpSocket * socket
Definition serversocketinterface.h:183
~TcpServerSocketInterface()
Definition serversocketinterface.cpp:1942
void flushOutputQueue()
Definition serversocketinterface.cpp:1970
int messageLength
Definition serversocketinterface.h:187
void initConnection(int socketDescriptor)
Definition serversocketinterface.cpp:1949
bool initTcpSession()
Definition serversocketinterface.cpp:2065
QString getConnectionType() const
Definition serversocketinterface.h:224
QString getAddress() const
Definition serversocketinterface.h:220
void binaryMessageReceived(const QByteArray &message)
Definition serversocketinterface.cpp:2204
WebsocketServerSocketInterface(Servatrice *_server, Servatrice_DatabaseInterface *_databaseInterface, QObject *parent=nullptr)
Definition serversocketinterface.cpp:2091
void flushOutputQueue()
Definition serversocketinterface.cpp:2173
~WebsocketServerSocketInterface()
Definition serversocketinterface.cpp:2098
QHostAddress getPeerAddress() const
Definition serversocketinterface.h:216
QHostAddress address
Definition serversocketinterface.h:231
void initConnection(void *_socket)
Definition serversocketinterface.cpp:2105
void flushSocket()
Definition serversocketinterface.h:238
QWebSocket * socket
Definition serversocketinterface.h:230
bool initWebsocketSession()
Definition serversocketinterface.cpp:2146
void writeToSocket(QByteArray &data)
Definition serversocketinterface.h:234