49 const char *undef =
"<undefined>";
51 if (!
value)
return dflt;
52 std::string svalue =
value;
53 if (svalue == undef)
return dflt;
55 if (svalue ==
"yes")
return 1;
56 if (svalue ==
"no")
return 0;
80 static std::shared_ptr<RWebWindowsManager> sInstance = std::make_shared<RWebWindowsManager>();
132 printf(
"\nWARNING!\n");
133 printf(
"Disabling loopback mode may leads to security problem.\n");
134 printf(
"See https://root.cern/about/security/ for more information.\n\n");
136 printf(
"Enforce session key to safely work on public network.\n");
137 printf(
"One may call RWebWindowsManager::SetUseSessionKey(false); to disable it.\n");
169 std::vector<unsigned char> buf(keylen, 0);
172 R__ASSERT(res == keylen &&
"Error in gSystem->GetCryptoRandom");
175 for (
int n = 0;
n < keylen;
n++) {
176 if ((
n > 0) && (
n % 4 == 0))
181 key.append(t.Data());
225 if (!fname || !*fname)
230 R__LOG_ERROR(
WebGUILog()) <<
"Problem with open listener socket " << fname <<
", check ROOT_LISTENER_SOCKET environment variable";
234 int res = s.
SendRaw(msg.c_str(), msg.length());
342 if (
gROOT->GetWebDisplay() ==
"off")
346 std::lock_guard<std::recursive_mutex> grd(
fMutex);
350 fServer = std::make_unique<THttpServer>(
"basic_sniffer");
361 if (send_thrds != -1)
382 R__LOG_ERROR(
WebGUILog()) <<
"Path to ROOT ui5 sources " << ui5dir <<
" not found, set ROOTUI5SYS correctly";
386 fServer->AddLocation(
"rootui5sys/", ui5dir.
Data());
389 if (!with_http ||
fServer->IsAnyEngine())
393 int http_min =
gEnv->
GetValue(
"WebGui.HttpPortMin", 8800);
394 int http_max =
gEnv->
GetValue(
"WebGui.HttpPortMax", 9800);
395 int http_timer =
gEnv->
GetValue(
"WebGui.HttpTimer", 10);
396 int http_thrds =
gEnv->
GetValue(
"WebGui.HttpThreads", 10);
397 int http_wstmout =
gEnv->
GetValue(
"WebGui.HttpWSTmout", 10000);
398 int http_maxage =
gEnv->
GetValue(
"WebGui.HttpMaxAge", -1);
399 const char *extra_args =
gEnv->
GetValue(
"WebGui.HttpExtraArgs",
"");
400 int fcgi_port =
gEnv->
GetValue(
"WebGui.FastCgiPort", 0);
401 int fcgi_thrds =
gEnv->
GetValue(
"WebGui.FastCgiThreads", 10);
402 const char *fcgi_serv =
gEnv->
GetValue(
"WebGui.FastCgiServer",
"");
405 const char *http_bind =
gEnv->
GetValue(
"WebGui.HttpBind",
"");
407 const char *ssl_cert =
gEnv->
GetValue(
"WebGui.ServerCert",
"rootserver.pem");
409 const char *unix_socket =
gSystem->
Getenv(
"ROOT_WEBGUI_SOCKET");
410 if (!unix_socket || !*unix_socket)
412 const char *unix_socket_mode =
gEnv->
GetValue(
"WebGui.UnixSocketMode",
"0700");
413 bool use_unix_socket = unix_socket && *unix_socket;
416 fcgi_port = http_port = -1;
423 if ((http_port < 0) && (fcgi_port <= 0) && !use_unix_socket) {
438 if (http_max - http_min < ntry)
439 ntry = http_max - http_min;
448 while (ntry-- >= 0) {
449 if ((http_port == 0) && (fcgi_port <= 0) && !use_unix_socket) {
450 if ((http_min <= 0) || (http_max <= http_min)) {
451 R__LOG_ERROR(
WebGUILog()) <<
"Wrong HTTP range configuration, check WebGui.HttpPortMin/Max variables";
455 http_port = (
int)(http_min + (http_max - http_min) *
gRandom->
Rndm(1));
460 engine.
Form(
"fastcgi:%d?thrds=%d", fcgi_port, fcgi_thrds);
461 if (!
fServer->CreateEngine(engine))
463 if (fcgi_serv && (strlen(fcgi_serv) > 0))
469 if (use_unix_socket) {
470 engine.
Form(
"socket:%s?socket_mode=%s&", unix_socket, unix_socket_mode);
472 url = use_secure ?
"https://" :
"http://";
473 engine.
Form(
"%s:%d?", (use_secure ?
"https" :
"http"), http_port);
474 if (assign_loopback) {
475 engine.
Append(
"loopback&");
477 }
else if (http_bind && (strlen(http_bind) > 0)) {
485 engine.
Append(
TString::Format(
"webgui&top=remote&thrds=%d&websocket_timeout=%d", http_thrds, http_wstmout));
487 if (http_maxage >= 0)
490 if (use_secure && !strchr(ssl_cert,
'&')) {
491 engine.
Append(
"&ssl_cert=");
495 if (!use_unix_socket && !assign_loopback && extra_args && strlen(extra_args) > 0) {
497 engine.
Append(extra_args);
500 if (
fServer->CreateEngine(engine)) {
501 if (use_unix_socket) {
503 fAddr.append(unix_socket);
505 }
else if (http_port > 0) {
508 fAddr.append(std::to_string(http_port));
513 use_unix_socket =
false;
528 std::lock_guard<std::recursive_mutex> grd(
fMutex);
535 std::shared_ptr<RWebWindow>
win = std::make_shared<RWebWindow>();
542 double dflt_tmout =
gEnv->
GetValue(
"WebGui.OperationTmout", 50.);
547 std::string fname, prefix;
549 prefix = std::string(
"f") + std::to_string(
fIdCnt) +
"_";
550 fname = std::string(
"protcol") + std::to_string(
fIdCnt) +
".json";
552 fname =
"protocol.json";
554 win->RecordData(fname, prefix);
561 win->fUseProcessEvents =
true;
565 win->UseServerThreads();
567 const char *token =
gEnv->
GetValue(
"WebGui.ConnToken",
"");
569 win->SetConnToken(token);
571 fServer->RegisterWS(wshandler);
596 std::string addr =
"/";
597 addr.append(
win.fWSHandler->GetName());
604 if (
win.IsRequireAuthKey() || produced_key) {
605 key =
win.GenerateKey();
607 addr.append(
"?key=");
610 std::unique_ptr<ROOT::RWebDisplayHandle> dummy;
611 win.AddDisplayHandle(
false, key, dummy);
614 auto token =
win.GetConnToken();
615 if (!token.empty()) {
616 if (!qmark) addr.append(
"?");
617 addr.append(
"token=");
696 auto handle = std::make_unique<RWebDisplayHandle>(
"");
697 win.AddDisplayHandle(
false,
"", handle);
714 if (!normal_http && (
gEnv->
GetValue(
"WebGui.ForceHttp", 0) == 1))
719 std::string url =
GetUrl(
win, normal_http, &key);
725 std::lock_guard<std::recursive_mutex> grd(
fMutex);
742 auto winurl = args.
GetUrl();
743 winurl.erase(0,
fAddr.length());
748 std::cout <<
"New web window: " << args.
GetUrl() << std::endl;
752 if (
fAddr.compare(0,9,
"socket://") == 0)
755#if !defined(R__MACOSX) && !defined(R__WIN32)
757 const char *varname =
"WebGui.CheckRemoteDisplay";
760 if (displ && *displ && (*displ !=
':')) {
763 "ROOT web-based widget started in the session where DISPLAY set to " << displ <<
"\n" <<
764 "Means web browser will be displayed on remote X11 server which is usually very inefficient\n"
765 "One can start ROOT session in server mode like \"root -b --web=server:8877\" and forward http port to display node\n"
766 "Or one can use rootssh script to configure pore forwarding and display web widgets automatically\n"
767 "Find more info on https://root.cern/for_developers/root7/#rbrowser\n"
768 "This message can be disabled by setting \"" << varname <<
": no\" in .rootrc file\n";
801 int res = 0, cnt = 0;
804 auto start = std::chrono::high_resolution_clock::now();
810 while ((res = check(spent)) == 0) {
819 std::this_thread::sleep_for(std::chrono::milliseconds(cnt > 5000 ? 10 : 1));
821 std::chrono::duration<double, std::milli> elapsed = std::chrono::high_resolution_clock::now() - start;
823 spent = elapsed.count() * 1
e-3;
825 if (timed && (spent > timelimit))
#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
static bool gWebWinUseSessionKey
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.
static std::string GenerateKey(int keylen=32)
Static method to generate cryptographic key Parameter keylen defines length of cryptographic key in b...
bool fUseSessionKey
! is session key has to be used for data signing
static void SetUseSessionKey(bool on=false)
Enable or disable usage of session key If enabled, each packet send to or from server is signed with ...
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.
std::string fSessionKey
! secret session key used on client to code connections keys
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
std::string GetUrl(RWebWindow &win, bool remote=false, std::string *produced_key=nullptr)
Provide URL address to access specified window from inside or from remote.
void Unregister(RWebWindow &win)
Release all references to specified window Called from RWebWindow destructor.
static bool IsLoopbackMode()
Returns true if loopback mode used by THttpServer for web widgets.
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.
static TString Itoa(Int_t value, Int_t base)
Converts an Int_t to a TString with respect to the base specified (2-36).
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 Int_t GetCryptoRandom(void *buf, Int_t len)
Return cryptographic random number Fill provided buffer with random values Returns number of bytes wr...
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.
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
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...