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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
/*
RailControl - Model Railway Control Software
Copyright (c) 2017-2025 by Teddy / Dominik Mahrer - www.railcontrol.org
RailControl 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 3, or (at your option) any
later version.
RailControl 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 RailControl; see the file LICENCE. If not see
<http://www.gnu.org/licenses/>.
*/
#pragma once
#include <cstring>
#include <deque>
#include <map>
#include <string>
#include <thread>
#include <vector>
#include "DataModel/AccessoryBase.h"
#include "DataModel/ObjectIdentifier.h"
#include "Languages.h"
#include "Manager.h"
#include "Network/TcpConnection.h"
#include "ResponseHtml.h"
#include "Server/Web/WebClientCluster.h"
#include "Server/Web/WebClientCounter.h"
#include "Server/Web/WebClientRoute.h"
#include "Server/Web/WebClientSignal.h"
#include "Server/Web/WebClientStatic.h"
#include "Server/Web/WebClientText.h"
#include "Server/Web/WebClientTrack.h"
namespace DataModel
{
class ObjectIdentifier;
class Cluster;
}
namespace Server { namespace Web
{
class WebServer;
class WebClient
{
public:
enum ResponseType : unsigned char
{
ResponseInfo = 'i',
ResponseWarning = 'w',
ResponseError = 'e'
};
WebClient() = delete;
WebClient(const WebClient&) = delete;
WebClient& operator=(const WebClient&) = delete;
inline WebClient(const unsigned int id,
Network::TcpConnection* connection, // connection must be deleted after using!
WebServer &webserver,
Manager& manager)
: logger(Logger::Logger::GetLogger("WebClient # " + std::to_string(id))),
id(id),
connection(connection),
run(false),
terminated(false),
server(webserver),
clientThread(&WebClient::Worker, this),
manager(manager),
cluster(manager, *this),
track(manager, *this, logger),
signal(manager, *this, logger),
route(manager, *this, logger),
text(manager, *this),
counter(manager, *this),
headOnly(false),
buttonID(0)
{
}
~WebClient();
void Worker();
inline void Stop()
{
run = false;
}
inline bool IsTerminated()
{
return terminated;
}
inline void ReplyHtmlWithHeader(const HtmlTag& tag)
{
connection->Send(ResponseHtml(tag));
}
inline void ReplyResponse(const std::string& text)
{
ReplyHtmlWithHeader(HtmlTag().AddContent(text));
}
inline void ReplyResponse(ResponseType type, const std::string& text)
{
std::string s(1, static_cast<unsigned char>(type));
s.append(text);
ReplyResponse(s);
}
template<typename... Args>
inline void ReplyResponse(ResponseType type, Languages::TextSelector text, Args... args)
{
std::string s(1, static_cast<unsigned char>(type));
s.append(Logger::Logger::Format(Languages::GetText(text), args...));
ReplyResponse(s);
}
inline void ReplyHtmlWithHeaderAndParagraph(const std::string& content)
{
ReplyHtmlWithHeader(HtmlTag("p").AddContent(content));
}
inline void ReplyHtmlWithHeaderAndParagraph(const char* content)
{
ReplyHtmlWithHeaderAndParagraph(std::string(content));
}
template<typename... Args>
inline void ReplyHtmlWithHeaderAndParagraph(const Languages::TextSelector text, Args... args)
{
ReplyHtmlWithHeaderAndParagraph(Logger::Logger::Format(Languages::GetText(text), args...));
}
HtmlTag HtmlTagSelectSlave(const std::string& prefix,
const std::vector<DataModel::Relation*>& relations,
const std::map<std::string,ObjectID>& options,
const bool allowNew = true) const;
inline HtmlTag HtmlTagTabPosition(const DataModel::LayoutItem::LayoutPosition posx,
const DataModel::LayoutItem::LayoutPosition posy,
const DataModel::LayoutItem::LayoutPosition posz,
const DataModel::LayoutItem::Visible visible) const
{
return HtmlTagTabPosition(posx, posy, posz, DataModel::LayoutItem::RotationNotRelevant, visible);
}
HtmlTag HtmlTagTabPosition(const DataModel::LayoutItem::LayoutPosition posx,
const DataModel::LayoutItem::LayoutPosition posy,
const DataModel::LayoutItem::LayoutPosition posz,
const DataModel::LayoutItem::LayoutRotation rotation = DataModel::LayoutItem::RotationNotRelevant,
const DataModel::LayoutItem::Visible visible = DataModel::LayoutItem::VisibleNotRelevant) const ;
HtmlTag HtmlTagControlLoco(ControlID& controlId, const std::string& objectType, const ObjectID objectID) const;
HtmlTag HtmlTagControlMultipleUnit(ControlID& controlId, const std::string& objectType, const ObjectID objectID) const;
HtmlTag HtmlTagControlAccessory(ControlID& controlID, const std::string& objectType, const ObjectID objectID) const;
HtmlTag HtmlTagControlFeedback(ControlID& controlId, const std::string& objectType, const ObjectID objectID) const;
HtmlTag HtmlTagProtocolAccessory(const ControlID controlID, const Protocol selectedProtocol);
HtmlTag HtmlTagSelectFeedbackForTrack(const unsigned int counter,
const TrackID trackID,
const FeedbackID feedbackID = FeedbackNone) const;
HtmlTag HtmlTagRelationSignalState(const std::string& name,
const SignalID signalId,
const DataModel::Relation::Data data = DataModel::SignalStateStop);
static std::string ProtocolName(const Protocol protocol)
{
return ProtocolSymbols[protocol <= ProtocolEnd ? protocol : ProtocolNone];
}
HtmlTag HtmlTagMatchKeyProtocolAccessory(const ControlID controlID,
const std::string& selectedMatchKey,
const Protocol selectedProtocol) const;
HtmlTag HtmlTagMatchKeyFeedback(const ControlID controlID,
const std::string& selectedMatchKey) const;
private:
void InterpretClientRequest(const std::deque<std::string>& lines, std::string& method, std::string& uri, std::string& protocol, std::map<std::string,std::string>& arguments, std::map<std::string,std::string>& headers);
void HandleLoco(const std::map<std::string, std::string>& arguments);
void PrintMainHTML();
void DeliverFile(const std::string& file);
void DeliverFileInternal(FILE* f, const char* realFile, const std::string& file);
HtmlTag HtmlTagLocoSelector(const std::string& selector, const LocoID locoID = LocoNone) const;
HtmlTag HtmlTagLayerSelector(const LayerID layerID = LayerNone) const;
HtmlTag HtmlTagMatchKeyProtocolLoco(const ControlID controlID,
const std::string& selectedMatchKey,
const Protocol selectedProtocol) const;
HtmlTag HtmlTagPosition(const DataModel::LayoutItem::LayoutPosition posx,
const DataModel::LayoutItem::LayoutPosition posy,
const DataModel::LayoutItem::LayoutPosition posz) const;
HtmlTag HtmlTagPosition(const DataModel::LayoutItem::LayoutPosition posx,
const DataModel::LayoutItem::LayoutPosition posy,
const DataModel::LayoutItem::LayoutPosition posz,
const DataModel::LayoutItem::Visible visible) const;
HtmlTag HtmlTagProgramModeSelector(const ControlID controlID, ProgramMode& mode) const;
HtmlTag HtmlTagCvFields(const ControlID controlID, const ProgramMode programMode) const;
HtmlTag HtmlTagInput8BitValueWithLabel() const;
HtmlTag HtmlTagInputBitValue(std::string name) const;
std::map<std::string,ObjectID> GetMultipleUnitSlaveOptions() const;
void HandleAskShutdown();
void HandleSelectLoco(const std::map<std::string, std::string>& arguments);
void HandleLayerEdit(const std::map<std::string, std::string>& arguments);
void HandleLayerSave(const std::map<std::string, std::string>& arguments);
void HandleLayerList();
void HandleLayerAskDelete(const std::map<std::string, std::string>& arguments);
void HandleLayerDelete(const std::map<std::string, std::string>& arguments);
void HandleControlEdit(const std::map<std::string, std::string>& arguments);
void HandleControlSave(const std::map<std::string, std::string>& arguments);
void HandleControlList();
void HandleControlAskDelete(const std::map<std::string, std::string>& arguments);
void HandleControlDelete(const std::map<std::string, std::string>& arguments);
void HandleLocoBaseSpeed(const std::map<std::string,std::string>& arguments);
void HandleLocoBaseOrientation(const std::map<std::string,std::string>& arguments);
void HandleLocoFunction(const std::map<std::string, std::string>& arguments);
void HandleLocoEdit(const std::map<std::string, std::string>& arguments);
void HandleLocoSave(const std::map<std::string, std::string>& arguments);
void HandleLocoList();
void HandleLocoAskDelete(const std::map<std::string, std::string>& arguments);
void HandleLocoDelete(const std::map<std::string, std::string>& arguments);
void HandleLocoRelease(const std::map<std::string, std::string>& arguments);
void HandleLocoAddTimeTable(const std::map<std::string, std::string>& arguments);
void HandleMultipleUnitEdit(const std::map<std::string, std::string>& arguments);
void HandleMultipleUnitSave(const std::map<std::string, std::string>& arguments);
void HandleMultipleUnitList();
void HandleMultipleUnitAskDelete(const std::map<std::string, std::string>& arguments);
void HandleMultipleUnitDelete(const std::map<std::string, std::string>& arguments);
void HandleMultipleUnitRelease(const std::map<std::string, std::string>& arguments);
void HandleProtocol(const std::map<std::string, std::string>& arguments);
void HandleAccessoryAddress(const std::map<std::string, std::string>& arguments);
void HandleLayout(const std::map<std::string,std::string>& arguments);
void HandleAccessoryEdit(const std::map<std::string,std::string>& arguments);
void HandleAccessorySave(const std::map<std::string,std::string>& arguments);
void HandleAccessoryState(const std::map<std::string,std::string>& arguments);
void HandleAccessoryList();
void HandleAccessoryAskDelete(const std::map<std::string,std::string>& arguments);
void HandleAccessoryDelete(const std::map<std::string,std::string>& arguments);
void HandleAccessoryGet(const std::map<std::string,std::string>& arguments);
void HandleAccessoryRelease(const std::map<std::string,std::string>& arguments);
void HandleSwitchEdit(const std::map<std::string,std::string>& arguments);
void HandleSwitchSave(const std::map<std::string,std::string>& arguments);
void HandleSwitchState(const std::map<std::string,std::string>& arguments);
void HandleSwitchList();
void HandleSwitchAskDelete(const std::map<std::string,std::string>& arguments);
void HandleSwitchDelete(const std::map<std::string,std::string>& arguments);
void HandleSwitchGet(const std::map<std::string,std::string>& arguments);
void HandleSwitchRelease(const std::map<std::string,std::string>& arguments);
void HandleFeedbackEdit(const std::map<std::string,std::string>& arguments);
void HandleFeedbackSave(const std::map<std::string,std::string>& arguments);
void HandleFeedbackState(const std::map<std::string,std::string>& arguments);
void HandleFeedbackList();
void HandleFeedbackAskDelete(const std::map<std::string,std::string>& arguments);
void HandleFeedbackDelete(const std::map<std::string,std::string>& arguments);
void HandleFeedbackGet(const std::map<std::string,std::string>& arguments);
void HandleLocoSelector(const std::map<std::string,std::string>& arguments);
void HandleLayerSelector(const std::map<std::string,std::string>& arguments);
void HandleFeedbackAdd(const std::map<std::string,std::string>& arguments);
void HandleSettingsEdit();
void HandleSettingsSave(const std::map<std::string, std::string>& arguments);
void HandleSlaveAdd(const std::map<std::string,std::string>& arguments);
void HandleTimestamp(const std::map<std::string,std::string>& arguments);
void HandleControlArguments(const std::map<std::string,std::string>& arguments);
void HandleProgram();
void HandleProgramModeSelector(const std::map<std::string,std::string>& arguments);
void HandleProgramRead(const std::map<std::string,std::string>& arguments);
void HandleProgramWrite(const std::map<std::string,std::string>& arguments);
void HandleCvFields(const std::map<std::string,std::string>& arguments);
void HandleNewPosition(const std::map<std::string,std::string>& arguments);
void HandleNewPositionInternal(const std::map<std::string,std::string>& arguments, std::string& result);
void HandleRotate(const std::map<std::string,std::string>& arguments);
void HandleUpdater(const std::map<std::string,std::string>& headers);
void WorkerImpl();
Logger::Logger* logger;
unsigned int id;
Network::TcpConnection* connection;
volatile bool run;
bool terminated;
WebServer& server;
std::thread clientThread;
Manager& manager;
WebClientCluster cluster;
WebClientTrack track;
WebClientSignal signal;
WebClientRoute route;
WebClientText text;
WebClientCounter counter;
bool headOnly;
unsigned int buttonID;
};
}} // namespace Server::Web
|
