Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TCivetweb.cxx
Go to the documentation of this file.
1// Author: Sergey Linev 21/12/2013
2
3/*************************************************************************
4 * Copyright (C) 1995-2022, Rene Brun and Fons Rademakers. *
5 * All rights reserved. *
6 * *
7 * For the licensing terms see $ROOTSYS/LICENSE. *
8 * For the list of contributors see $ROOTSYS/README/CREDITS. *
9 *************************************************************************/
10
11#include "TCivetweb.h"
12
13#include <cstdlib>
14#include <cstring>
15
16#ifdef _MSC_VER
17#include <windows.h>
18#include <tchar.h>
19#endif
20
21#include "THttpServer.h"
22#include "THttpWSEngine.h"
23#include "TUrl.h"
24#include "TSystem.h"
25#include "TError.h"
26
27//////////////////////////////////////////////////////////////////////////
28/// TCivetwebWSEngine
29///
30/// Implementation of THttpWSEngine for Civetweb
31
33protected:
35
36 /// True websocket requires extra thread to parallelize sending
37 Bool_t SupportSendThrd() const override { return kTRUE; }
38
39public:
41
42 ~TCivetwebWSEngine() override = default;
43
44 UInt_t GetId() const override { return TString::Hash((void *)&fWSconn, sizeof(void *)); }
45
46 void ClearHandle(Bool_t terminate) override
47 {
48 if (fWSconn && terminate)
50 fWSconn = nullptr;
51 }
52
53 void Send(const void *buf, int len) override
54 {
55 if (fWSconn)
57 }
58
59 /////////////////////////////////////////////////////////
60 /// Special method to send binary data with text header
61 /// For normal websocket it is two separated operation, for other engines could be combined together,
62 /// but emulates as two messages on client side
63 void SendHeader(const char *hdr, const void *buf, int len) override
64 {
65 if (fWSconn) {
68 }
69 }
70
71 void SendCharStar(const char *str) override
72 {
73 if (fWSconn)
75 }
76};
77
78//////////////////////////////////////////////////////////////////////////
79/// Check if engine has enough threads to process connect to new websocket handle
80
82{
84 if (longpoll) num_avail++;
85
86 if ((num_avail <= 0.1 * engine->GetNumThreads()) || (num_avail <= 2)) {
87 const char *cfg = engine->IsWebGui() ? "WebGui.HttpThreads parameter in rootrc" : "thrds=N parameter in config URL";
88 const char *place = longpoll ? "TCivetweb::LongpollHandler" : "TCivetweb::WebSocketHandler";
89 ::Error(place, "Only %d threads are available, reject connection request for %s. Increase %s, now it is %d", num_avail, uri, cfg, engine->GetNumThreads());
90 return kFALSE;
91 }
92
93 return kTRUE;
94}
95
96//////////////////////////////////////////////////////////////////////////
97
99{
101 if (!request_info)
102 return 1;
103
104 TCivetweb *engine = (TCivetweb *)request_info->user_data;
105 if (!engine || engine->IsTerminating())
106 return 1;
107 THttpServer *serv = engine->GetServer();
108 if (!serv)
109 return 1;
110
111 auto arg = std::make_shared<THttpCallArg>();
112 arg->SetPathAndFileName(request_info->local_uri); // path and file name
113 arg->SetQuery(request_info->query_string); // query arguments
114 arg->SetTopName(engine->GetTopName());
115 arg->SetWSId(TString::Hash((void *)&conn, sizeof(void *)));
116 arg->SetMethod("WS_CONNECT");
117
118 if (!CheckEngineThreads(engine, arg->GetPathName(), kFALSE))
119 return 1;
120
121 Bool_t execres = serv->ExecuteWS(arg, kTRUE, kTRUE);
122
123 return execres && !arg->Is404() ? 0 : 1;
124}
125
126//////////////////////////////////////////////////////////////////////////
127
129{
131
132 TCivetweb *engine = (TCivetweb *)request_info->user_data;
133 if (!engine || engine->IsTerminating())
134 return;
135 THttpServer *serv = engine->GetServer();
136 if (!serv)
137 return;
138
139 engine->ChangeNumActiveThreads(1);
140
141 auto arg = std::make_shared<THttpCallArg>();
142 arg->SetPathAndFileName(request_info->local_uri); // path and file name
143 arg->SetQuery(request_info->query_string); // query arguments
144 arg->SetTopName(engine->GetTopName());
145 arg->SetMethod("WS_READY");
146
147 // delegate ownership to the arg, id will be automatically set
148 arg->CreateWSEngine<TCivetwebWSEngine>(conn);
149
150 serv->ExecuteWS(arg, kTRUE, kTRUE);
151}
152
153
154//////////////////////////////////////////////////////////////////////////
155
156void websocket_close_handler(const struct mg_connection *conn, void *)
157{
159
160 // check if connection was already closed
161 if (mg_get_user_connection_data(conn) == (void *) conn)
162 return;
163
164 TCivetweb *engine = (TCivetweb *)request_info->user_data;
165 if (!engine || engine->IsTerminating())
166 return;
167 THttpServer *serv = engine->GetServer();
168 if (!serv)
169 return;
170
171 auto arg = std::make_shared<THttpCallArg>();
172 arg->SetPathAndFileName(request_info->local_uri); // path and file name
173 arg->SetQuery(request_info->query_string); // query arguments
174 arg->SetTopName(engine->GetTopName());
175 arg->SetWSId(TString::Hash((void *)&conn, sizeof(void *)));
176 arg->SetMethod("WS_CLOSE");
177
178 serv->ExecuteWS(arg, kTRUE, kFALSE); // do not wait for result of execution
179
180 engine->ChangeNumActiveThreads(-1);
181}
182
183//////////////////////////////////////////////////////////////////////////
184
185int websocket_data_handler(struct mg_connection *conn, int code, char *data, size_t len, void *)
186{
188
189 // check if connection data set to connection itself - means connection was closed already
190 std::string *conn_data = (std::string *) mg_get_user_connection_data(conn);
191 if ((void *) conn_data == (void *) conn)
192 return 1;
193
194 // see https://datatracker.ietf.org/doc/html/rfc6455#section-5.2
195 int fin = code & 0x80, opcode = code & 0x0F;
196
197 // recognized operation codes, all other should fails
198 enum { OP_CONTINUE = 0, OP_TEXT = 1, OP_BINARY = 2, OP_CLOSE = 8 };
199
200 // close when normal close is detected
201 if (fin && (opcode == OP_CLOSE)) {
202 if (conn_data) delete conn_data;
204 mg_set_user_connection_data(conn, conn); // mark connection as closed
205 return 1;
206 }
207
208 // ignore empty data
209 if (len == 0)
210 return 1;
211
212 // close connection when unrecognized opcode is detected
213 if ((opcode != OP_CONTINUE) && (opcode != OP_TEXT) && (opcode != OP_BINARY)) {
214 if (conn_data) delete conn_data;
216 mg_set_user_connection_data(conn, conn); // mark connection as closed
217 return 1;
218 }
219
220 TCivetweb *engine = (TCivetweb *)request_info->user_data;
221 if (!engine || engine->IsTerminating())
222 return 1;
223 THttpServer *serv = engine->GetServer();
224 if (!serv)
225 return 1;
226
227 // this is continuation of the request
228 if (!fin) {
229 if (!conn_data) {
230 conn_data = new std::string(data,len);
232 } else {
233 conn_data->append(data,len);
234 }
235 return 1;
236 }
237
238 auto arg = std::make_shared<THttpCallArg>();
239 arg->SetPathAndFileName(request_info->local_uri); // path and file name
240 arg->SetQuery(request_info->query_string); // query arguments
241 arg->SetTopName(engine->GetTopName());
242 arg->SetWSId(TString::Hash((void *)&conn, sizeof(void *)));
243 arg->SetMethod("WS_DATA");
244
245 if (conn_data) {
247 conn_data->append(data,len);
248 arg->SetPostData(std::move(*conn_data));
249 delete conn_data;
250 } else {
251 arg->SetPostData(std::string(data,len));
252 }
253
254 serv->ExecuteWS(arg, kTRUE, kTRUE);
255
256 return 1;
257}
258
259
260//////////////////////////////////////////////////////////////////////////
261
262static int log_message_handler(const struct mg_connection *conn, const char *message)
263{
264 const struct mg_context *ctx = mg_get_context(conn);
265
267
268 if (engine)
269 return engine->ProcessLog(message);
270
271 // provide debug output
272 if ((gDebug > 0) || strstr(message, "cannot bind to"))
273 fprintf(stderr, "Error in <TCivetweb::Log> %s\n", message);
274
275 return 0;
276}
277
287
288//////////////////////////////////////////////////////////////////////////
289/// Returns kTRUE in case of longpoll connection request - or at least looks like that
290
291Bool_t IsBadLongPollConnect(TCivetweb *engine, const std::shared_ptr<THttpCallArg> &arg)
292{
293 if (strcmp(arg->GetFileName(), "root.longpoll") != 0)
294 return kFALSE;
295
296 const char *q = arg->GetQuery();
297 if (!q || !*q)
298 return kFALSE;
299
300 if ((strstr(q, "raw_connect") != q) && (strstr(q, "txt_connect") != q))
301 return kFALSE;
302
303 return !CheckEngineThreads(engine, arg->GetPathName(), kTRUE);
304}
305
306//////////////////////////////////////////////////////////////////////////
307
308static int begin_request_handler(struct mg_connection *conn, void *)
309{
311
312 TCivetweb *engine = (TCivetweb *)request_info->user_data;
313 if (!engine || engine->IsTerminating())
314 return 0;
315 THttpServer *serv = engine->GetServer();
316 if (!serv)
317 return 0;
318
320
321 auto arg = std::make_shared<THttpCallArg>();
322
324
325 Bool_t execres = kTRUE, debug = engine->IsDebugMode();
326
327 if (!debug && serv->IsFileRequested(request_info->local_uri, filename)) {
328 if ((filename.Length() > 3) && ((filename.Index(".js") != kNPOS) || (filename.Index(".css") != kNPOS))) {
329 std::string buf = THttpServer::ReadFileContent(filename.Data());
330 if (buf.empty()) {
331 arg->Set404();
332 } else {
333 arg->SetContentType(THttpServer::GetMimeType(filename.Data()));
334 arg->SetContent(std::move(buf));
335 if (engine->GetMaxAge() > 0)
336 arg->AddHeader("Cache-Control", TString::Format("max-age=%d", engine->GetMaxAge()));
337 else
338 arg->AddNoCacheHeader();
339 arg->SetZipping();
340 }
341 } else {
342 arg->SetFile(filename.Data());
343 }
344 } else {
345 arg->SetPathAndFileName(request_info->local_uri); // path and file name
346 arg->SetQuery(request_info->query_string); // query arguments
347 arg->SetTopName(engine->GetTopName());
348 arg->SetMethod(request_info->request_method); // method like GET or POST
349 if (request_info->remote_user)
350 arg->SetUserName(request_info->remote_user);
351
352 TString header;
353 for (int n = 0; n < request_info->num_headers; n++)
354 header.Append(
355 TString::Format("%s: %s\r\n", request_info->http_headers[n].name, request_info->http_headers[n].value));
356 arg->SetRequestHeader(header);
357
358 const char *len = mg_get_header(conn, "Content-Length");
359 Int_t ilen = len ? TString(len).Atoi() : 0;
360
361 if (ilen > 0) {
362 std::string buf;
363 buf.resize(ilen);
364 Int_t iread = mg_read(conn, (void *) buf.data(), ilen);
365 if (iread == ilen)
366 arg->SetPostData(std::move(buf));
367 }
368
369 if (debug) {
371 cont.Append("<title>Civetweb echo</title>");
372 cont.Append("<h1>Civetweb echo</h1>\n");
373
374 static int count = 0;
375
376 cont.Append(TString::Format("Request %d:<br/>\n<pre>\n", ++count));
377 cont.Append(TString::Format(" Method : %s\n", arg->GetMethod()));
378 cont.Append(TString::Format(" PathName : %s\n", arg->GetPathName()));
379 cont.Append(TString::Format(" FileName : %s\n", arg->GetFileName()));
380 cont.Append(TString::Format(" Query : %s\n", arg->GetQuery()));
381 cont.Append(TString::Format(" PostData : %ld\n", arg->GetPostDataLength()));
382 if (arg->GetUserName())
383 cont.Append(TString::Format(" User : %s\n", arg->GetUserName()));
384
385 cont.Append("</pre><p>\n");
386
387 cont.Append("Environment:<br/>\n<pre>\n");
388 for (int n = 0; n < request_info->num_headers; n++)
389 cont.Append(
390 TString::Format(" %s = %s\n", request_info->http_headers[n].name, request_info->http_headers[n].value));
391 cont.Append("</pre><p>\n");
392
393 arg->SetContentType("text/html");
394
395 arg->SetContent(cont);
396
397 } else if (IsBadLongPollConnect(engine, arg)) {
398 execres = kFALSE;
399 arg->Set404();
400 } else {
401 execres = serv->ExecuteHttp(arg);
402 }
403 }
404
405 if (!execres || arg->Is404()) {
406 std::string hdr = arg->FillHttpHeader("HTTP/1.1");
407 mg_printf(conn, "%s", hdr.c_str());
408 } else if (arg->IsFile()) {
409 filename = (const char *)arg->GetContent();
410#ifdef _MSC_VER
411 if (engine->IsWinSymLinks()) {
412 // resolve Windows links which are not supported by civetweb
413 auto hFile = CreateFile(filename.Data(), // file to open
414 GENERIC_READ, // open for reading
415 FILE_SHARE_READ, // share for reading
416 NULL, // default security
417 OPEN_EXISTING, // existing file only
418 FILE_ATTRIBUTE_NORMAL, // normal file
419 NULL); // no attr. template
420
422 const int BUFSIZE = 2048;
425 // produced file name may include \\?\ symbols, which are indicating long file name
426 if(dwRet < BUFSIZE) {
427 if (dwRet > 4 && Path[0] == '\\' && Path[1] == '\\' && Path[2] == '?' && Path[3] == '\\')
428 filename = Path + 4;
429 else
430 filename = Path;
431 }
433 }
434 }
435#endif
436 const char *mime_type = THttpServer::GetMimeType(filename.Data());
437 if (mime_type)
439 else
440 mg_send_file(conn, filename.Data());
441 } else {
442
444 switch (arg->GetZipping()) {
445 case THttpCallArg::kNoZip: dozip = kFALSE; break;
447 if (arg->GetContentLength() < 10000) break;
449 // check if request header has Accept-Encoding
450 for (int n = 0; n < request_info->num_headers; n++) {
451 TString name = request_info->http_headers[n].name;
452 if (name.Index("Accept-Encoding", 0, TString::kIgnoreCase) != 0)
453 continue;
454 TString value = request_info->http_headers[n].value;
455 dozip = (value.Index("gzip", 0, TString::kIgnoreCase) != kNPOS);
456 break;
457 }
458
459 break;
460 case THttpCallArg::kZipAlways: dozip = kTRUE; break;
461 }
462
463 if (dozip)
464 arg->CompressWithGzip();
465
466 std::string hdr = arg->FillHttpHeader("HTTP/1.1");
467 mg_printf(conn, "%s", hdr.c_str());
468
469 if (arg->IsChunked()) {
470 // send first portion
471
472 unsigned last_send = arg->GetContentLength();
473 mg_send_chunk(conn, (const char *)arg->GetContent(), last_send);
474
475 while (arg->IsChunked() && last_send) {
476 // loop
477 arg->SetContent("");
478
479 serv->ExecuteHttp(arg);
480
481 last_send = arg->GetContentLength();
482
483 mg_send_chunk(conn, (const char *)arg->GetContent(), last_send);
484 }
485
486 // to correctly complete chunk operation, send 0 buffer at the end
487 if (last_send)
488 mg_send_chunk(conn, "", 0);
489
490 } else if (arg->GetContentLength() > 0)
491 mg_write(conn, arg->GetContent(), (size_t)arg->GetContentLength());
492 }
493
494 // Returning non-zero tells civetweb that our function has replied to
495 // the client, and civetweb should not send client any more data.
496 return 1;
497}
498
499/** \class TCivetweb
500
501THttpEngine implementation, based on civetweb embedded server
502
503It is default kind of engine, created for THttpServer
504When `builtin_civetweb=ON` (default), the release is grabbed from https://github.com/civetweb/civetweb corresponding
505to the version defined in https://github.com/root-project/root/blob/master/builtins/civetweb/CMakeLists.txt
506Switching to `builtin_civetweb=OFF` in order to use system-packages only works if the package was compiled with ROOT-mandatory features active.
507
508Additional options can be specified:
509
510 top=foldername - name of top folder, seen in the browser
511 thrds=N - use N threads to run civetweb server (default 5)
512 auth_file - global authentication file
513 auth_domain - domain name, used for authentication
514
515Example:
516
517 new THttpServer("http:8080?top=MyApp&thrds=3");
518
519For the full list of supported options see TCivetweb::Create() documentation
520
521When `auth_file` and `auth_domain` parameters are specified, access
522to running http server will be possible only after user
523authentication, using so-call digest method. To generate
524authentication file, htdigest routine should be used:
525
526 [shell] htdigest -c .htdigest domain_name user
527
528When creating server, parameters should be:
529
530 auto serv = new THttpServer("http:8080?auth_file=.htdigets&auth_domain=domain_name");
531
532*/
533
534////////////////////////////////////////////////////////////////////////////////
535/// constructor
536
538 : THttpEngine("civetweb", "compact embedded http server"),
539 fOnlySecured(only_secured)
540{
541}
542
543////////////////////////////////////////////////////////////////////////////////
544/// destructor
545
547{
548 if (fCtx && !fTerminating)
549 mg_stop(fCtx);
550
552}
553
554////////////////////////////////////////////////////////////////////////////////
555/// process civetweb log message, can be used to detect critical errors
556
557Int_t TCivetweb::ProcessLog(const char *message)
558{
559 if ((gDebug > 0) || strstr(message, "cannot bind to"))
560 Error("Log", "%s", message);
561
562 return 0;
563}
564
565////////////////////////////////////////////////////////////////////////////////
566/// Returns number of actively used threads
567
569{
570 std::lock_guard<std::mutex> guard(fMutex);
572}
573
574////////////////////////////////////////////////////////////////////////////////
575/// Returns number of actively used threads
576
578{
579 std::lock_guard<std::mutex> guard(fMutex);
580 fNumActiveThreads += cnt;
581 return fNumActiveThreads;
582}
583
584
585////////////////////////////////////////////////////////////////////////////////
586/// Creates embedded civetweb server
587///
588/// @param args string with civetweb server configuration
589///
590/// As main argument, http port should be specified like "8090".
591/// Or one can provide combination of ipaddress and portnumber like "127.0.0.1:8090"
592/// Or one can specify unix socket name like "x/tmp/root.socket"
593/// Extra parameters like in URL string could be specified after '?' mark:
594///
595/// thrds=N - there N is number of threads used by the civetweb (default is 10)
596/// top=name - configure top name, visible in the web browser
597/// ssl_cert=filename - SSL certificate, see docs/OpenSSL.md from civetweb
598/// auth_file=filename - authentication file name, created with htdigets utility
599/// auth_domain=domain - authentication domain
600/// websocket_timeout=tm - set web sockets timeout in seconds (default 300)
601/// websocket_disable - disable web sockets handling (default enabled)
602/// bind - ip address to bind server socket
603/// loopback - bind specified port to loopback 127.0.0.1 address
604/// debug - enable debug mode, server always returns html page with request info
605/// log=filename - configure civetweb log file
606/// max_age=value - configures "Cache-Control: max_age=value" http header for all file-related requests, default 3600
607/// socket_mode=value - configures unix socket mode, default is 0700
608/// nocache - try to fully disable cache control for file requests
609/// winsymlinks=no - do not resolve symbolic links on file system (Windows only), default true
610/// dirlisting=no - enable/disable directory listing for browsing filesystem (default no)
611///
612/// Examples of valid args values:
613///
614/// serv->CreateEngine("http:8080?websocket_disable");
615/// serv->CreateEngine("http:7546?thrds=30&websocket_timeout=20");
616
617Bool_t TCivetweb::Create(const char *args)
618{
619 memset(&fCallbacks, 0, sizeof(struct mg_callbacks));
620 // fCallbacks.begin_request = begin_request_handler;
621 fCallbacks.log_message = log_message_handler;
622 TString sport = IsSecured() ? "8480s" : "8080",
624 websocket_timeout = "300000",
625 dir_listening = "no",
626 auth_file,
628 log_file,
629 ssl_cert,
630 max_age;
631 Int_t socket_mode = 0700;
632 bool use_ws = kTRUE, is_socket = false;
633
634 // extract arguments
635 if (args && *args) {
636
637 // first extract port number
638 sport = "";
639
640 is_socket = *args == 'x';
641
642 while ((*args != 0) && (*args != '?') && (is_socket || (*args != '/')))
643 sport.Append(*args++);
644 if (IsSecured() && (sport.Index("s") == kNPOS) && !is_socket)
645 sport.Append("s");
646
647 // than search for extra parameters
648 while ((*args != 0) && (*args != '?'))
649 args++;
650
651 if (*args == '?') {
652 TUrl url(TString::Format("http://localhost/folder%s", args));
653
654 if (url.IsValid()) {
655 url.ParseOptions();
656
657 fWebGui = url.HasOption("webgui");
658
659 const char *top = url.GetValueFromOptions("top");
660 if (top)
661 fTopName = top;
662
663 const char *log = url.GetValueFromOptions("log");
664 if (log)
665 log_file = log;
666
667 Int_t thrds = url.GetIntValueFromOptions("thrds");
668 if (thrds > 0)
670
671 const char *afile = url.GetValueFromOptions("auth_file");
672 if (afile)
674
675 const char *adomain = url.GetValueFromOptions("auth_domain");
676 if (adomain)
678
679 const char *sslc = url.GetValueFromOptions("ssl_certificate");
680 if (!sslc)
681 sslc = url.GetValueFromOptions("ssl_cert");
682 if (sslc)
683 ssl_cert = sslc;
684
685 Int_t wtmout = url.GetIntValueFromOptions("websocket_timeout");
686 if (wtmout > 0) {
687 websocket_timeout.Format("%d", wtmout * 1000);
688 use_ws = kTRUE;
689 }
690
691 if (url.HasOption("websocket_disable"))
692 use_ws = kFALSE;
693
694 if (url.HasOption("debug"))
695 fDebug = kTRUE;
696
697 const char *winsymlinks = url.GetValueFromOptions("winsymlinks");
698 if (winsymlinks)
699 fWinSymLinks = strcmp(winsymlinks,"no") != 0;
700
701 const char *dls = url.GetValueFromOptions("dirlisting");
702 if (dls && (!strcmp(dls,"no") || !strcmp(dls,"yes")))
704
705 const char *smode = url.GetValueFromOptions("socket_mode");
706 if (smode)
707 socket_mode = std::stoi(smode, nullptr, *smode=='0' ? 8 : 10);
708
709 if (url.HasOption("loopback") && (sport.Index(":") == kNPOS))
710 sport = TString("127.0.0.1:") + sport;
711
712 if (url.HasOption("bind") && (sport.Index(":") == kNPOS)) {
713 const char *addr = url.GetValueFromOptions("bind");
714 if (addr && strlen(addr))
715 sport = TString(addr) + ":" + sport;
716 }
717
718 if (GetServer() && url.HasOption("cors")) {
719 const char *cors = url.GetValueFromOptions("cors");
720 GetServer()->SetCors(cors && *cors ? cors : "*");
721 }
722
723 if (GetServer() && url.HasOption("cred_cors")) {
724 const char *cred = url.GetValueFromOptions("cred_cors");
725 GetServer()->SetCorsCredentials(cred && *cred ? cred : "true");
726 }
727
728 if (url.HasOption("nocache"))
729 fMaxAge = 0;
730
731 if (url.HasOption("max_age"))
732 fMaxAge = url.GetIntValueFromOptions("max_age");
733
734 max_age.Form("%d", fMaxAge);
735 }
736 }
737 }
738
739 num_threads.Form("%d", fNumThreads);
740
741 const char *options[34];
742 int op = 0;
743
744 Info("Create", "Starting HTTP server on port %s", sport.Data());
745
746 options[op++] = "listening_ports";
747 options[op++] = sport.Data();
748 options[op++] = "num_threads";
749 options[op++] = num_threads.Data();
750
751 if (use_ws) {
752 options[op++] = "websocket_timeout_ms";
753 options[op++] = websocket_timeout.Data();
754 }
755
756 if ((auth_file.Length() > 0) && (auth_domain.Length() > 0)) {
757 options[op++] = "global_auth_file";
758 options[op++] = auth_file.Data();
759 options[op++] = "authentication_domain";
760 options[op++] = auth_domain.Data();
761 } else {
762 options[op++] = "enable_auth_domain_check";
763 options[op++] = "no";
764 }
765
766 if (log_file.Length() > 0) {
767 options[op++] = "error_log_file";
768 options[op++] = log_file.Data();
769 }
770
771 if (ssl_cert.Length() > 0) {
772 options[op++] = "ssl_certificate";
773 options[op++] = ssl_cert.Data();
774 } else if (IsSecured()) {
775 Error("Create", "No SSL certificate file configured");
776 }
777
778 if (max_age.Length() > 0) {
779 options[op++] = "static_file_max_age";
780 options[op++] = max_age.Data();
781 }
782
783 if (GetServer() && GetServer()->IsCors()) {
784 // also used for the file transfer
785 options[op++] = "access_control_allow_origin";
786 options[op++] = GetServer()->GetCors();
787 }
788
789 if (GetServer() && GetServer()->IsCorsCredentials()) {
790 options[op++] = "access_control_allow_credentials";
791 options[op++] = GetServer()->GetCorsCredentials();
792 options[op++] = "access_control_expose_headers";
793 options[op++] = "Content-Range, Content-Length, Date";
794 options[op++] = "access_control_allow_methods";
795 options[op++] = "GET, HEAD, OPTIONS";
796 }
797
798 options[op++] = "enable_directory_listing";
799 options[op++] = dir_listening.Data();
800
801 options[op++] = nullptr;
802
804 Error("Create", "civetweb compiled without sockets binding support");
805 return kFALSE;
806 }
807
809 Error("Create", "civetweb compiled without SSL support");
810 return kFALSE;
811 }
812
814 Error("Create", "civetweb compiled without websockets support");
815 return kFALSE;
816 }
817
818 if (IsSecured()) {
819 /* Initialize with SSL support */
821 } else {
822 /* Initialize without SSL support */
824 }
825
826 // try to remove socket file - if any
827 if (is_socket && !sport.Contains(","))
828 gSystem->Unlink(sport.Data()+1);
829
830 // Start the web server.
831 fCtx = mg_start(&fCallbacks, this, options);
832
833 if (!fCtx)
834 return kFALSE;
835
837
838 if (use_ws)
841
842 // try to remove socket file - if any
843 if (is_socket && !sport.Contains(","))
844 gSystem->Chmod(sport.Data()+1, socket_mode);
845
846 return kTRUE;
847}
bool Bool_t
Boolean (0=false, 1=true) (bool)
Definition RtypesCore.h:78
int Int_t
Signed integer 4 bytes (int)
Definition RtypesCore.h:60
constexpr Bool_t kFALSE
Definition RtypesCore.h:109
constexpr Ssiz_t kNPOS
The equivalent of std::string::npos for the ROOT class TString.
Definition RtypesCore.h:132
constexpr Bool_t kTRUE
Definition RtypesCore.h:108
int websocket_connect_handler(const struct mg_connection *conn, void *)
Definition TCivetweb.cxx:98
static int begin_request_handler(struct mg_connection *conn, void *)
static int log_message_handler(const struct mg_connection *conn, const char *message)
int websocket_data_handler(struct mg_connection *conn, int code, char *data, size_t len, void *)
void websocket_close_handler(const struct mg_connection *conn, void *)
Bool_t CheckEngineThreads(TCivetweb *engine, const char *uri, Bool_t longpoll)
Check if engine has enough threads to process connect to new websocket handle.
Definition TCivetweb.cxx:81
void websocket_ready_handler(struct mg_connection *conn, void *)
Bool_t IsBadLongPollConnect(TCivetweb *engine, const std::shared_ptr< THttpCallArg > &arg)
Returns kTRUE in case of longpoll connection request - or at least looks like that.
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
void Error(const char *location, const char *msgfmt,...)
Use this function in case an error occurred.
Definition TError.cxx:208
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void data
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t UChar_t len
char name[80]
Definition TGX11.cxx:148
float * q
#define INVALID_HANDLE_VALUE
Definition TMapFile.cxx:84
Int_t gDebug
Global variable setting the debug level. Set to 0 to disable, increase it in steps of 1 to increase t...
Definition TROOT.cxx:792
R__EXTERN TSystem * gSystem
Definition TSystem.h:582
#define BUFSIZE
TCivetwebWSEngine.
Definition TCivetweb.cxx:32
struct mg_connection * fWSconn
Definition TCivetweb.cxx:34
UInt_t GetId() const override
Definition TCivetweb.cxx:44
void SendCharStar(const char *str) override
Envelope for sending string via the websocket.
Definition TCivetweb.cxx:71
void ClearHandle(Bool_t terminate) override
Definition TCivetweb.cxx:46
Bool_t SupportSendThrd() const override
True websocket requires extra thread to parallelize sending.
Definition TCivetweb.cxx:37
~TCivetwebWSEngine() override=default
void SendHeader(const char *hdr, const void *buf, int len) override
Special method to send binary data with text header For normal websocket it is two separated operatio...
Definition TCivetweb.cxx:63
void Send(const void *buf, int len) override
Definition TCivetweb.cxx:53
TCivetwebWSEngine(struct mg_connection *conn)
Definition TCivetweb.cxx:40
THttpEngine implementation, based on civetweb embedded server.
Definition TCivetweb.h:21
Int_t fNumThreads
! number of configured threads
Definition TCivetweb.h:25
Int_t fNumActiveThreads
! number of active threads - used in request and websocket handling
Definition TCivetweb.h:26
struct mg_context * fCtx
! civetweb context
Definition TCivetweb.h:23
std::mutex fMutex
! mutex to read/write fNumActiveThreads
Definition TCivetweb.h:27
Bool_t fWinSymLinks
! resolve symbolic links on Windows
Definition TCivetweb.h:34
Bool_t IsTerminating() const
Definition TCivetweb.h:60
Int_t GetMaxAge() const
Definition TCivetweb.h:66
const char * GetTopName() const
Definition TCivetweb.h:54
TCivetweb(Bool_t only_secured=kFALSE)
constructor
Int_t fMaxAge
! max-age parameter
Definition TCivetweb.h:33
Bool_t IsWebGui() const
Definition TCivetweb.h:56
Int_t ProcessLog(const char *message)
process civetweb log message, can be used to detect critical errors
TString fTopName
! name of top item
Definition TCivetweb.h:28
Int_t GetNumAvailableThreads()
Returns number of actively used threads.
Bool_t fTerminating
! server doing shutdown and not react on requests
Definition TCivetweb.h:31
Bool_t Create(const char *args) override
Creates embedded civetweb server.
Int_t GetNumThreads() const
Definition TCivetweb.h:46
Bool_t IsSecured() const
Definition TCivetweb.h:38
Bool_t IsDebugMode() const
Definition TCivetweb.h:58
virtual ~TCivetweb()
destructor
Bool_t IsWinSymLinks() const
Definition TCivetweb.h:62
Bool_t fWebGui
! if server used for webgui
Definition TCivetweb.h:29
Bool_t fDebug
! debug mode
Definition TCivetweb.h:30
Int_t ChangeNumActiveThreads(int cnt=0)
Returns number of actively used threads.
struct mg_callbacks fCallbacks
! call-back table for civetweb webserver
Definition TCivetweb.h:24
Abstract class for implementing http protocol for THttpServer.
Definition THttpEngine.h:19
THttpServer * GetServer() const
Returns pointer to THttpServer associated with engine.
Definition THttpEngine.h:40
Online http server for arbitrary ROOT application.
Definition THttpServer.h:31
const char * GetCors() const
Returns specified CORS domain.
void SetCorsCredentials(const std::string &value="true")
Enable/disable usage Access-Control-Allow-Credentials response header.
void SetCors(const std::string &domain="*")
Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-C...
const char * GetCorsCredentials() const
Returns specified CORS credentials value - if any.
static char * ReadFileContent(const char *filename, Int_t &len)
Reads content of file from the disk.
static const char * GetMimeType(const char *path)
Guess mime type base on file extension.
Internal instance used to exchange WS functionality between THttpServer and THttpWSHandler.
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1096
virtual void Info(const char *method, const char *msgfmt,...) const
Issue info message.
Definition TObject.cxx:1070
Basic string class.
Definition TString.h:138
Int_t Atoi() const
Return integer value of string.
Definition TString.cxx:2068
@ kIgnoreCase
Definition TString.h:285
UInt_t Hash(ECaseCompare cmp=kExact) const
Return hash value.
Definition TString.cxx:684
TString & Append(const char *cs)
Definition TString.h:583
static TString Format(const char *fmt,...)
Static method which formats a string using a printf style format descriptor and return a TString.
Definition TString.cxx:2459
virtual int Chmod(const char *file, UInt_t mode)
Set the file permission bits. Returns -1 in case or error, 0 otherwise.
Definition TSystem.cxx:1523
virtual int Unlink(const char *name)
Unlink, i.e.
Definition TSystem.cxx:1396
This class represents a WWW compatible URL.
Definition TUrl.h:33
const Int_t n
Definition legend1.C:16
TCivetweb * fEngine
TEngineHolder(TCivetweb *engine)