1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/****************************************************************************
**
** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "aspectcommanddebugger_p.h"
#include <QtNetwork/QTcpSocket>
#include <QtCore/QJsonDocument>
#include <QtCore/QJsonObject>
#include <Qt3DCore/private/qabstractaspect_p.h>
#include <Qt3DCore/private/qsysteminformationservice_p.h>
QT_BEGIN_NAMESPACE
namespace Qt3DCore {
namespace Debug {
namespace {
const qint32 MagicNumber = 0x454;
struct CommandHeader
{
qint32 magic;
qint32 size;
};
} // anonymous
void AspectCommandDebugger::ReadBuffer::insert(const QByteArray &array)
{
buffer.insert(endIdx, array);
endIdx += array.size();
}
void AspectCommandDebugger::ReadBuffer::trim()
{
if (startIdx != endIdx && startIdx != 0) {
memcpy(buffer.data(),
buffer.constData() + startIdx,
size());
endIdx -= startIdx;
startIdx = 0;
}
}
AspectCommandDebugger::AspectCommandDebugger(QSystemInformationService *parent)
: QTcpServer(parent)
, m_service(parent)
{
}
void AspectCommandDebugger::initialize()
{
QObject::connect(this, &QTcpServer::newConnection, [this] {
QTcpSocket *socket = nextPendingConnection();
m_connections.push_back(socket);
QObject::connect(socket, &QTcpSocket::disconnected, [this, socket] {
m_connections.removeOne(socket);
// Destroy object to make sure all QObject connection are removed
socket->deleteLater();
});
QObject::connect(socket, &QTcpSocket::readyRead, [this, socket] {
onCommandReceived(socket);
});
});
const bool listening = listen(QHostAddress::Any, 8883);
if (!listening)
qWarning() << Q_FUNC_INFO << "failed to listen on port 8883";
}
void AspectCommandDebugger::asynchronousReplyFinished(AsynchronousCommandReply *reply)
{
Q_ASSERT(reply->isFinished());
QTcpSocket *socket = m_asyncCommandToSocketEntries.take(reply);
if (m_connections.contains(socket)) {
QJsonObject replyObj;
replyObj.insert(QLatin1String("command"), QJsonValue(reply->commandName()));
replyObj.insert(QLatin1String("data"), QJsonDocument::fromJson(reply->data()).object());
sendReply(socket, QJsonDocument(replyObj).toJson());
}
reply->deleteLater();
}
// Expects to receive commands in the form
// CommandHeader { MagicNumber; size }
// JSON {
// command: "commandName"
// data: JSON Obj
// }
void AspectCommandDebugger::onCommandReceived(QTcpSocket *socket)
{
const QByteArray newData = socket->readAll();
m_readBuffer.insert(newData);
const int commandPacketSize = sizeof(CommandHeader);
while (m_readBuffer.size() >= commandPacketSize) {
CommandHeader *header = reinterpret_cast<CommandHeader *>(m_readBuffer.buffer.data() + m_readBuffer.startIdx);
if (header->magic == MagicNumber) {
// Early return, header is valid but we haven't yet received all the data
if ((m_readBuffer.size() - commandPacketSize) < header->size)
return;
// We have a valid command
// We expect command to be a CommandHeader + some json text
const QJsonDocument doc = QJsonDocument::fromJson(
QByteArray(m_readBuffer.buffer.data() + m_readBuffer.startIdx + commandPacketSize,
header->size));
if (!doc.isNull()) {
// Send command to the aspectEngine
QJsonObject commandObj = doc.object();
const QJsonValue commandNameValue = commandObj.value(QLatin1String("command"));
executeCommand(commandNameValue.toString(), socket);
}
m_readBuffer.startIdx += commandPacketSize + header->size;
}
}
// Copy remaining length of buffer at begininning if we have read some commands
// and some partial one remain
m_readBuffer.trim();
}
void AspectCommandDebugger::sendReply(QTcpSocket *socket, const QByteArray &payload)
{
CommandHeader replyHeader;
replyHeader.magic = MagicNumber;
replyHeader.size = payload.size();
// Write header
socket->write(reinterpret_cast<const char *>(&replyHeader), sizeof(CommandHeader));
// Write payload
socket->write(payload.constData(), payload.size());
}
void AspectCommandDebugger::executeCommand(const QString &command,
QTcpSocket *socket)
{
// Only a single aspect is going to reply
const QVariant response = m_service->executeCommand(command);
if (response.userType() == qMetaTypeId<AsynchronousCommandReply *>()) { // AsynchronousCommand
// Store the command | socket in a table
AsynchronousCommandReply *reply = response.value<AsynchronousCommandReply *>();
// Command has already been completed
if (reply->isFinished()) {
asynchronousReplyFinished(reply);
} else { // Command is not completed yet
QObject::connect(reply, &AsynchronousCommandReply::finished,
this, &AspectCommandDebugger::asynchronousReplyFinished);
m_asyncCommandToSocketEntries.insert(reply, socket);
}
} else { // Synchronous command
// and send response to client
QJsonObject reply;
reply.insert(QLatin1String("command"), QJsonValue(command));
// TO DO: convert QVariant to QJsonDocument/QByteArray
sendReply(socket, QJsonDocument(reply).toJson());
}
}
} // Debug
} // Qt3DCore
QT_END_NAMESPACE
|
