48 const char *undef =
"<undefined>";
50 if (!
value)
return dflt;
51 std::string svalue =
value;
52 if (svalue == undef)
return dflt;
54 if (svalue ==
"yes")
return 1;
55 if (svalue ==
"no")
return 0;
79 static std::shared_ptr<RWebWindowsManager> sInstance = std::make_shared<RWebWindowsManager>();
130 printf(
"\nWARNING!\n");
131 printf(
"Disabling loopback mode may leads to security problem.\n");
132 printf(
"See https://root.cern/about/security/ for more information.\n\n");
173 if (!fname || !*fname)
178 R__LOG_ERROR(
WebGUILog()) <<
"Problem with open listener socket " << fname <<
", check ROOT_LISTENER_SOCKET environment variable";
182 int res = s.
SendRaw(msg.c_str(), msg.length());
290 if (
gROOT->GetWebDisplay() ==
"off")
294 std::lock_guard<std::recursive_mutex> grd(
fMutex);
298 fServer = std::make_unique<THttpServer>(
"basic_sniffer");
309 if (send_thrds != -1)
330 R__LOG_ERROR(
WebGUILog()) <<
"Path to ROOT ui5 sources " << ui5dir <<
" not found, set ROOTUI5SYS correctly";
334 fServer->AddLocation(
"rootui5sys/", ui5dir.
Data());
337 if (!with_http ||
fServer->IsAnyEngine())
341 int http_min =
gEnv->
GetValue(
"WebGui.HttpPortMin", 8800);
342 int http_max =
gEnv->
GetValue(
"WebGui.HttpPortMax", 9800);
343 int http_timer =
gEnv->
GetValue(
"WebGui.HttpTimer", 10);
344 int http_thrds =
gEnv->
GetValue(
"WebGui.HttpThreads", 10);
345 int http_wstmout =
gEnv->
GetValue(
"WebGui.HttpWSTmout", 10000);
346 int http_maxage =
gEnv->
GetValue(
"WebGui.HttpMaxAge", -1);
347 const char *extra_args =
gEnv->
GetValue(
"WebGui.HttpExtraArgs",
"");
348 int fcgi_port =
gEnv->
GetValue(
"WebGui.FastCgiPort", 0);
349 int fcgi_thrds =
gEnv->
GetValue(
"WebGui.FastCgiThreads", 10);
350 const char *fcgi_serv =
gEnv->
GetValue(
"WebGui.FastCgiServer",
"");
353 const char *http_bind =
gEnv->
GetValue(
"WebGui.HttpBind",
"");
355 const char *ssl_cert =
gEnv->
GetValue(
"WebGui.ServerCert",
"rootserver.pem");
357 const char *unix_socket =
gSystem->
Getenv(
"ROOT_WEBGUI_SOCKET");
358 if (!unix_socket || !*unix_socket)
360 const char *unix_socket_mode =
gEnv->
GetValue(
"WebGui.UnixSocketMode",
"0700");
361 bool use_unix_socket = unix_socket && *unix_socket;
364 fcgi_port = http_port = -1;
371 if ((http_port < 0) && (fcgi_port <= 0) && !use_unix_socket) {
386 if (http_max - http_min < ntry)
387 ntry = http_max - http_min;
396 while (ntry-- >= 0) {
397 if ((http_port == 0) && (fcgi_port <= 0) && !use_unix_socket) {
398 if ((http_min <= 0) || (http_max <= http_min)) {
399 R__LOG_ERROR(
WebGUILog()) <<
"Wrong HTTP range configuration, check WebGui.HttpPortMin/Max variables";
403 http_port = (
int)(http_min + (http_max - http_min) *
gRandom->
Rndm(1));
408 engine.
Form(
"fastcgi:%d?thrds=%d", fcgi_port, fcgi_thrds);
409 if (!
fServer->CreateEngine(engine))
411 if (fcgi_serv && (strlen(fcgi_serv) > 0))
417 if (use_unix_socket) {
418 engine.
Form(
"socket:%s?socket_mode=%s&", unix_socket, unix_socket_mode);
420 url = use_secure ?
"https://" :
"http://";
421 engine.
Form(
"%s:%d?", (use_secure ?
"https" :
"http"), http_port);
422 if (assign_loopback) {
423 engine.
Append(
"loopback&");
425 }
else if (http_bind && (strlen(http_bind) > 0)) {
435 if (http_maxage >= 0)
438 if (use_secure && !strchr(ssl_cert,
'&')) {
439 engine.
Append(
"&ssl_cert=");
443 if (!use_unix_socket && !assign_loopback && extra_args && strlen(extra_args) > 0) {
445 engine.
Append(extra_args);
448 if (
fServer->CreateEngine(engine)) {
449 if (use_unix_socket) {
451 fAddr.append(unix_socket);
453 }
else if (http_port > 0) {
456 fAddr.append(std::to_string(http_port));
461 use_unix_socket =
false;
476 std::lock_guard<std::recursive_mutex> grd(
fMutex);
483 std::shared_ptr<RWebWindow>
win = std::make_shared<RWebWindow>();
490 double dflt_tmout =
gEnv->
GetValue(
"WebGui.OperationTmout", 50.);
495 std::string fname, prefix;
497 prefix = std::string(
"f") + std::to_string(
fIdCnt) +
"_";
498 fname = std::string(
"protcol") + std::to_string(
fIdCnt) +
".json";
500 fname =
"protocol.json";
502 win->RecordData(fname, prefix);
509 win->fUseProcessEvents =
true;
513 win->UseServerThreads();
515 const char *token =
gEnv->
GetValue(
"WebGui.ConnToken",
"");
517 win->SetConnToken(token);
519 fServer->RegisterWS(wshandler);
544 std::string addr =
"/";
546 addr.append(
win.fWSHandler->GetName());
617 auto handle = std::make_unique<RWebDisplayHandle>(
"");
618 win.AddDisplayHandle(
false,
"", handle);
623 auto token =
win.GetConnToken();
626 std::lock_guard<std::recursive_mutex> grd(
fMutex);
633 std::string key =
win.GenerateKey();
656 if (!normal_http && (
gEnv->
GetValue(
"WebGui.ForceHttp", 0) == 1))
659 std::string url =
GetUrl(
win, normal_http);
664 if (normal_http &&
fAddr.empty()) {
678 auto winurl = args.
GetUrl();
679 winurl.erase(0,
fAddr.length());
684 std::cout <<
"New web window: " << args.
GetUrl() << std::endl;
688 if (
fAddr.compare(0,9,
"socket://") == 0)
691#if !defined(R__MACOSX) && !defined(R__WIN32)
693 const char *varname =
"WebGui.CheckRemoteDisplay";
696 if (displ && *displ && (*displ !=
':')) {
699 "ROOT web-based widget started in the session where DISPLAY set to " << displ <<
"\n" <<
700 "Means web browser will be displayed on remote X11 server which is usually very inefficient\n"
701 "One can start ROOT session in server mode like \"root -b --web=server:8877\" and forward http port to display node\n"
702 "Or one can use rootssh script to configure pore forwarding and display web widgets automatically\n"
703 "Find more info on https://root.cern/for_developers/root7/#rbrowser\n"
704 "This message can be disabled by setting \"" << varname <<
": no\" in .rootrc file\n";
735 int res = 0, cnt = 0;
738 auto start = std::chrono::high_resolution_clock::now();
744 while ((res = check(spent)) == 0) {
753 std::this_thread::sleep_for(std::chrono::milliseconds(cnt > 5000 ? 10 : 1));
755 std::chrono::duration<double, std::milli> elapsed = std::chrono::high_resolution_clock::now() - start;
757 spent = elapsed.count() * 1
e-3;
759 if (timed && (spent > timelimit))
#define R__LOG_WARNING(...)
#define R__LOG_ERROR(...)
static bool gWebWinMainThrdSet
static std::thread::id gWebWinMainThrd
This thread id used to identify main application thread, where ROOT event processing runs To inject c...
static bool gWebWinLoopbackMode
R__EXTERN TApplication * gApplication
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void on
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 win
R__EXTERN TRandom * gRandom
R__EXTERN TSystem * gSystem
Holds different arguments for starting browser with RWebDisplayHandle::Display() method.
std::string GetBrowserName() const
Returns configured browser name.
EBrowserKind GetBrowserKind() const
returns configured browser kind, see EBrowserKind for supported values
RWebDisplayArgs & SetX(int x=-1)
set preferable web window x position, negative is default
bool IsSupportHeadless() const
returns true if browser supports headless mode
RWebDisplayArgs & SetUrl(const std::string &url)
set window url
int GetWidth() const
returns preferable web window width
const std::string & GetUrl() const
returns window url
void AppendUrlOpt(const std::string &opt)
append extra url options, add "&" as separator if required
int GetY() const
set preferable web window y position
int GetHeight() const
returns preferable web window height
void SetHttpServer(THttpServer *serv)
set http server instance, used for window display
RWebDisplayArgs & SetWidth(int w=0)
set preferable web window width
bool IsInteractiveBrowser() const
returns true if interactive browser window supposed to be started
RWebDisplayArgs & SetY(int y=-1)
set preferable web window y position, negative is default
bool IsHeadless() const
returns headless mode
RWebDisplayArgs & SetHeight(int h=0)
set preferable web window height
@ kServer
indicates that ROOT runs as server and just printouts window URL, browser should be started by the us...
@ kOff
disable web display, do not start any browser
@ kEmbedded
window will be embedded into other, no extra browser need to be started
int GetX() const
set preferable web window x position
bool IsLocalDisplay() const
returns true if local display like CEF or Qt5 QWebEngine should be used
static std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args)
Create web display.
static int GetBoolEnv(const std::string &name, int dfl=-1)
Parse boolean gEnv variable which should be "yes" or "no".
Represents web window, which can be shown in web browser or any other supported environment.
std::string GetUrl(const RWebWindow &win, bool remote=false)
Provide URL address to access specified window from inside or from remote.
bool CreateServer(bool with_http=false)
Creates http server, if required - with real http engine (civetweb) One could configure concrete HTTP...
bool fExternalProcessEvents
! indicate that there are external process events engine
std::recursive_mutex fMutex
! main mutex, used for window creations
RWebWindowsManager()
window manager constructor Required here for correct usage of unique_ptr<THttpServer>
int WaitFor(RWebWindow &win, WebWindowWaitFunc_t check, bool timed=false, double tm=-1)
Waits until provided check function or lambdas returns non-zero value Regularly calls WebWindow::Sync...
WebWindowShowCallback_t fShowCallback
! function called for each RWebWindow::Show call
unsigned ShowWindow(RWebWindow &win, const RWebDisplayArgs &args)
Show window in specified location, see Show() method for more details.
std::string fAddr
! HTTP address of the server
void Terminate()
Terminate http server and ROOT application.
unsigned fIdCnt
! counter for identifiers
~RWebWindowsManager()
window manager destructor Required here for correct usage of unique_ptr<THttpServer>
THttpServer * GetServer() const
Returns THttpServer instance.
bool fUseHttpThrd
! use special thread for THttpServer
static void AssignMainThrd()
Re-assigns main thread id Normally main thread id recognized at the moment when library is loaded It ...
bool IsUseHttpThread() const
Returns true if http server use special thread for requests processing (default off)
bool fUseSenderThreads
! use extra threads for sending data from RWebWindow to clients
std::unique_ptr< THttpServer > fServer
! central communication with the all used displays
static void SetLoopbackMode(bool on=true)
Set loopback mode for THttpServer used for web widgets By default is on.
static bool IsMainThrd()
Returns true when called from main process Main process recognized at the moment when library is load...
static std::shared_ptr< RWebWindowsManager > & Instance()
Returns default window manager Used to display all standard ROOT elements like TCanvas or TFitPanel.
bool InformListener(const std::string &msg)
If ROOT_LISTENER_SOCKET variable is configured, message will be sent to that unix socket.
float fLaunchTmout
! timeout in seconds to start browser process, default 30s
void Unregister(RWebWindow &win)
Release all references to specified window Called from RWebWindow destructor.
std::shared_ptr< RWebWindow > CreateWindow()
Creates new window To show window, RWebWindow::Show() have to be called.
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
virtual void SetValue(const char *name, const char *value, EEnvLevel level=kEnvChange, const char *type=nullptr)
Set the value of a resource or create a new resource.
Bool_t Connect(const char *signal, const char *receiver_class, void *receiver, const char *slot)
Non-static method is used to connect from the signal of this object to the receiver slot.
Bool_t Disconnect(const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
Disconnects signal of this object from slot of receiver.
static const TString & GetDataDir()
Get the data directory in the installation. Static utility function.
virtual void SetSeed(ULong_t seed=0)
Set the random generator seed.
Double_t Rndm() override
Machine independent random number generator.
virtual void Close(Option_t *opt="")
Close the socket.
virtual Int_t SendRaw(const void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
Send a raw buffer of specified length.
virtual Bool_t IsValid() const
const char * Data() const
TString & Append(const char *cs)
static TString Format(const char *fmt,...)
Static method which formats a string using a printf style format descriptor and return a TString.
void Form(const char *fmt,...)
Formats a string using a printf style format descriptor.
virtual Bool_t ExpandPathName(TString &path)
Expand a pathname getting rid of special shell characters like ~.
virtual const char * Getenv(const char *env)
Get environment variable.
virtual void Sleep(UInt_t milliSec)
Sleep milliSec milli seconds.
virtual Bool_t ProcessEvents()
Process pending events (GUI, timers, sockets).
static void SingleShot(Int_t milliSec, const char *receiver_class, void *receiver, const char *method)
This static function calls a slot after a given time interval.
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.
ROOT::Experimental::RLogChannel & WebGUILog()
Log channel for WebGUI diagnostics.
std::function< int(double)> WebWindowWaitFunc_t
function signature for waiting call-backs Such callback used when calling thread need to waits for so...