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
|
/*
* WebApiController.h - declaration of WebApiController class
*
* Copyright (c) 2020-2025 Tobias Junghans <tobydox@veyon.io>
*
* This file is part of Veyon - https://veyon.io
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program (see COPYING); if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
#pragma once
#include <QReadWriteLock>
#include <QThread>
#include "EnumHelper.h"
#include "LockingPointer.h"
#include "WebApiConnection.h"
#define waDebug() if (VeyonCore::isDebugging()==false); else qDebug() << "[WebAPI]"
class WebApiConfiguration;
class WebApiController : public QObject
{
Q_OBJECT
public:
enum class Key
{
State,
Method,
Methods,
Credentials,
Format,
Compression,
Quality,
Width,
Height,
Feature,
Name,
Uid,
ParentUid,
Active,
Arguments,
Login,
FullName,
SessionId,
SessionUptime,
SessionClientAddress,
SessionClientName,
SessionHostName,
ValidUntil
};
Q_ENUM(Key)
enum class Error
{
NoError,
InvalidData,
InvalidConnection,
InvalidFeature,
InvalidCredentials,
AuthenticationMethodNotAvailable,
AuthenticationFailed,
ConnectionLimitReached,
ConnectionTimedOut,
UnsupportedImageFormat,
FramebufferNotAvailable,
FramebufferEncodingError,
ProtocolMismatch,
};
struct Request
{
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
using Headers = QList<QPair<QByteArray, QByteArray>>;
#else
using Headers = QVariantMap;
#endif
Request(const QString& p = {}, const Headers& h = {}, const QVariantMap& d = {}) : path(p), headers(h), data(d) { }
QString path{};
Headers headers{};
QVariantMap data{};
};
struct Response
{
Response( const QVariantMap& md = {} ) : mapData(md) { }
Response( const QVariantList& ad ) : arrayData(ad) { }
Response( const QByteArray& bd ) : binaryData(bd) { }
Response( Error e, const QString& ed = {} ) : error(e), errorDetails(ed) { }
QVariantList arrayData{};
QVariantMap mapData{};
QByteArray binaryData{};
Error error{Error::NoError};
QString errorDetails{};
};
explicit WebApiController( const WebApiConfiguration& configuration, QObject* parent = nullptr );
~WebApiController() override;
Response getHostState(const Request& request, const QString& host);
Response getAuthenticationMethods( const Request& request, const QString& host );
Response performAuthentication( const Request& request, const QString& host );
Response closeConnection( const Request& request, const QString& host );
Response getFramebuffer( const Request& request );
Response listFeatures( const Request& request );
Response setFeatureStatus( const Request& request, const QString& feature );
Response getFeatureStatus( const Request& request, const QString& feature );
Response getUserInformation( const Request& request );
Response getSessionInformation(const Request& request);
QString getStatistics();
QString getConnectionDetails();
Response sleep(const Request& request, const int& seconds);
static QString errorString( Error error );
private:
void runInWorkerThread(const std::function<void()>& functor) const;
void runInWorkerThreadNonBlocking(const std::function<void()>& functor) const;
template<class T>
T runInWorkerThread(const std::function<T()>& functor) const;
void removeConnection( QUuid connectionUuid );
void incrementVncFramebufferUpdatesCounter();
void updateStatistics();
static constexpr auto MillisecondsPerSecond = 1000;
static constexpr auto MillisecondsPerHour = MillisecondsPerSecond * 60 * 60;
static constexpr auto StatisticsUpdateIntervalSeconds = 10;
static QString k2s( Key key )
{
return EnumHelper::toCamelCaseString( key );
}
static QByteArray connectionUidHeaderFieldName()
{
return QByteArrayLiteral("Connection-Uid");
}
static QByteArray lookupHeaderField(const Request& request, const QByteArray& fieldName);
using WebApiConnectionPointer = QSharedPointer<WebApiConnection>;
using LockingConnectionPointer = LockingPointer<WebApiConnectionPointer>;
LockingConnectionPointer lookupConnection( const Request& request );
using CheckFunction = std::function<Response(const WebApiController*, const QVariantMap &)>;
Response checkConnection( const Request& request );
Response checkFeature( const QString& featureUid );
const WebApiConfiguration& m_configuration;
QMap<QUuid, WebApiConnectionPointer> m_connections{};
QReadWriteLock m_connectionsLock;
QThread* m_workerThread = nullptr;
QObject* m_workerObject = nullptr;
QTimer m_updateStatisticsTimer{this};
QAtomicInt m_apiTotalRequestsCounter = 0;
QAtomicInt m_framebufferRequestsCounter = 0;
QAtomicInt m_vncFramebufferUpdatesCounter = 0;
QAtomicInt m_apiTotalRequestsLast = 0;
QAtomicInt m_framebufferRequestsLast = 0;
QAtomicInt m_vncFramebufferUpdatesLast = 0;
QAtomicInt m_apiTotalRequestsPerSecond = 0;
QAtomicInt m_framebufferRequestsPerSecond = 0;
QAtomicInt m_vncFramebufferUpdatesPerSecond = 0;
};
|
