17#include "RConfigure.h"
44#include <crt_externs.h>
51using namespace std::string_literals;
67 static std::map<std::string, std::unique_ptr<RWebDisplayHandle::Creator>>
sMap;
83 if (
libname ==
"ChromeCreator") {
84 m.emplace(
name, std::make_unique<ChromeCreator>(
name ==
"edge"));
85 }
else if (
libname ==
"FirefoxCreator") {
86 m.emplace(
name, std::make_unique<FirefoxCreator>());
87 }
else if (
libname ==
"SafariCreator") {
88 m.emplace(
name, std::make_unique<SafariCreator>());
89 }
else if (
libname ==
"BrowserCreator") {
90 m.emplace(
name, std::make_unique<BrowserCreator>(
false));
101 static std::unique_ptr<RWebDisplayHandle::Creator> dummy;
139 gSystem->
Exec((
"taskkill /F /PID "s + std::to_string(
fPid) +
" >NUL 2>NUL").c_str());
140 std::string rmdir =
"rmdir /S /Q ",
rmfile =
"del /F ";
144 std::string rmdir =
"rm -rf ",
rmfile =
"rm -f ";
164 if (exec.find(
"$url") == std::string::npos) {
167 fExec = exec +
" $url";
169 fExec = exec +
" $url &";
173 auto pos = exec.find(
" ");
174 if (pos != std::string::npos)
175 fProg = exec.substr(0, pos);
178 fExec =
"open \'$url\'";
180 fExec =
"start $url";
182 fExec =
"xdg-open \'$url\' &";
191 if (
nexttry.empty() || !fProg.empty())
196 fProg = std::regex_replace(
nexttry, std::regex(
"%20"),
" ");
209 if (pos != std::string::npos)
227std::unique_ptr<RWebDisplayHandle>
235 std::cout <<
"New web window: " <<
url << std::endl;
236 return std::make_unique<RWebBrowserHandle>(
url,
"",
"",
"");
243 exec = fHeadlessExec;
247 exec =
"$prog $url &";
257 ProcessGeometry(exec, args);
264 if (((
url.find(
"token=") != std::string::npos) || (
url.find(
"key=") != std::string::npos)) && !args.
IsBatchMode() && !args.
IsHeadless()) {
274 std::string
content = std::regex_replace(
276 "<html lang=\"en\">\n"
278 " <meta charset=\"utf-8\">\n"
279 " <meta http-equiv=\"refresh\" content=\"0;url=$url\"/>\n"
280 " <title>Opening ROOT widget</title>\n"
284 " This page should redirect you to a ROOT widget. If it doesn't,\n"
285 " <a href=\"$url\">click here to go to ROOT</a>.\n"
288 "</html>\n", std::regex(
"\$url"),
url);
309 exec = std::regex_replace(exec, std::regex(
"\$rootetcdir"),
TROOT::GetEtcDir().Data());
310 exec = std::regex_replace(exec, std::regex(
"\$url"),
url);
311 exec = std::regex_replace(exec, std::regex(
"\$width"),
swidth);
312 exec = std::regex_replace(exec, std::regex(
"\$height"),
sheight);
313 exec = std::regex_replace(exec, std::regex(
"\$posx"),
sposx);
314 exec = std::regex_replace(exec, std::regex(
"\$posy"),
sposy);
316 if (exec.compare(0,5,
"fork:") == 0) {
339 std::vector<char *>
argv;
340 argv.push_back((
char *) fProg.c_str());
342 argv.push_back((
char *)
fargs->At(
n)->GetName());
343 argv.push_back(
nullptr);
345 R__LOG_DEBUG(0,
WebGUILog()) <<
"Show web window in browser with posix_spawn:\n" << fProg <<
" " << exec;
401 if (
dump_content.find(
"<div>###batch###job###done###</div>") != std::string::npos)
434 if (
gEnv->
GetValue(
"WebGui.PreserveBatchFiles", -1) > 0)
435 ::Info(
"RWebDisplayHandle::Display",
"Preserve dump file %s",
redirect.c_str());
444 return std::make_unique<RWebBrowserHandle>(
url, rmdir,
tmpfile, pid);
456 exec =
"wmic process call create '"s +
gSystem->
UnixPathName(fProg.c_str()) +
" " + exec +
"' | find \"ProcessId\" "s;
462 ss >> tmp >>
c >> pid;
472 return std::make_unique<RWebBrowserHandle>(
url, rmdir,
tmpfile, pid);
478 if (exec.rfind(
"&") == exec.length() - 1) {
481 exec.resize(exec.length() - 1);
483 std::vector<char *>
argv;
492 argv.push_back((
char *)
fargs->At(
n)->GetName());
493 argv.push_back(
nullptr);
499 return std::make_unique<RWebBrowserHandle>(
url, rmdir,
tmpfile,
""s);
507 std::string
prog = std::regex_replace(fProg, std::regex(
" "),
"\ ");
509 std::string
prog = fProg;
514 exec = std::regex_replace(exec, std::regex(
"\$prog"),
prog);
519 if (exec.find(
"$dumpfile") != std::string::npos) {
520 exec = std::regex_replace(exec, std::regex(
"\$dumpfile"),
redirect);
522 auto p = exec.length();
523 if (exec.rfind(
"&") ==
p-1) --
p;
536 if (
gEnv->
GetValue(
"WebGui.PreserveBatchFiles", -1) > 0)
537 ::Info(
"RWebDisplayHandle::Display",
"Preserve dump file %s",
redirect.c_str());
581 TestProg(
"\Microsoft\Edge\Application\msedge.exe",
true);
583 TestProg(
"\Google\Chrome\Application\chrome.exe",
true);
586 TestProg(
"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome");
590 TestProg(
"/usr/bin/chromium-browser");
591 TestProg(
"/usr/bin/chrome-browser");
592 TestProg(
"/usr/bin/google-chrome-stable");
614 fBatchExec =
gEnv->
GetValue((
fEnvPrefix +
"Batch").c_str(),
"fork:--headless --no-sandbox --disable-extensions --disable-audio-output $geometry --dump-dom $url");
618 fBatchExec =
gEnv->
GetValue((
fEnvPrefix +
"Batch").c_str(),
"fork:--headless=new --no-sandbox --disable-extensions --disable-audio-output $geometry --dump-dom $url");
621 fExec =
gEnv->
GetValue((
fEnvPrefix +
"Interactive").c_str(),
"$prog $geometry --new-window --app=\'$url\' >/dev/null 2>/dev/null &");
632 std::string geometry;
639 if (!geometry.append(
" ");
641 std::to_string(args.
GetY() >= 0 ? args.
GetY() : 0));
645 if (!geometry.append(
" ");
649 exec = std::regex_replace(exec, std::regex(
"\$geometry"), geometry);
660 if (exec.find(
"$profile") == std::string::npos)
677 profile_arg +=
"root_chrome_profile_"s + std::to_string(
rnd.Integer(0x100000));
682 exec = std::regex_replace(exec, std::regex(
"\$profile"),
profile_arg);
696 TestProg(
"\Mozilla Firefox\firefox.exe",
true);
699 TestProg(
"/Applications/Firefox.app/Contents/MacOS/firefox");
711 fExec =
gEnv->
GetValue(
"WebGui.FirefoxInteractive",
"$prog -no-remote $profile $geometry $url &");
713 fBatchExec =
gEnv->
GetValue(
"WebGui.FirefoxBatch",
"fork:--headless -no-remote -new-instance $profile $url");
715 fExec =
gEnv->
GetValue(
"WebGui.FirefoxInteractive",
"$rootetcdir/runfirefox.sh __nodump__ $cleanup_profile $prog -no-remote $profile $geometry -url \'$url\' &");
724 std::string geometry;
728 exec = std::regex_replace(exec, std::regex(
"\$geometry"), geometry);
738 if (exec.find(
"$profile") == std::string::npos)
760 profile_dir +=
"root_ff_profile_"s + std::to_string(
rnd.Integer(0x100000));
770 user_js <<
"user_pref(\"datareporting.policy.dataSubmissionPolicyAcceptedVersion\", 2);" << std::endl;
771 user_js <<
"user_pref(\"datareporting.policy.dataSubmissionPolicyNotifiedTime\", \"1635760572813\");" << std::endl;
774 user_js <<
"user_pref(\"browser.tabs.closeWindowWithLastTab\", true);" << std::endl;
775 user_js <<
"user_pref(\"dom.allow_scripts_to_close_windows\", true);" << std::endl;
776 user_js <<
"user_pref(\"browser.sessionstore.resume_from_crash\", false);" << std::endl;
780 user_js <<
"user_pref(\"browser.dom.window.dump.enabled\", true);" << std::endl;
783 user_js <<
"user_pref(\"datareporting.policy.firstRunURL\", \"\");" << std::endl;
785 user_js <<
"user_pref(\"toolkit.legacyUserProfileCustomizations.stylesheets\", true);" << std::endl;
787 user_js <<
"user_pref(\"browser.tabs.inTitlebar\", 0);" << std::endl;
791 times_json <<
" \"created\": 1699968480952," << std::endl;
792 times_json <<
" \"firstUse\": null" << std::endl;
795 std::ofstream
style(
profile_dir +
"/chrome/userChrome.css", std::ios::trunc);
797 style <<
"#TabsToolbar { visibility: collapse; }" << std::endl;
799 style <<
"#nav-bar, #urlbar-container, #searchbar { visibility: collapse !important; }" << std::endl;
808 exec = std::regex_replace(exec, std::regex(
"\$profile"),
profile_arg);
810 if (exec.find(
"$cleanup_profile") != std::string::npos) {
811 if (rmdir.empty()) rmdir =
"__dummy__";
812 exec = std::regex_replace(exec, std::regex(
"\$cleanup_profile"), rmdir);
834 if (
qt6 &&
qt6->IsActive())
839 if (
qt5 &&
qt5->IsActive())
844 if (
cef &&
cef->IsActive())
861 std::unique_ptr<RWebDisplayHandle> handle;
866 auto try_creator = [&](std::unique_ptr<Creator> &creator) {
867 if (!creator || !creator->IsActive())
869 handle = creator->Display(args);
870 return handle ?
true :
false;
943 std::unique_ptr<Creator> creator = std::make_unique<BrowserCreator>(
false, args.
GetCustomExec());
987 if (
h1 &&
h1->IsActive()) {
993 auto &h2 =
FindCreator(
"firefox",
"FirefoxCreator");
994 if (h2 && h2->IsActive()) {
1005 return h1 &&
h1->IsActive();
1009 auto &h2 =
FindCreator(
"firefox",
"FirefoxCreator");
1010 return h2 && h2->IsActive();
1016 return h3 && h3->IsActive();
1047 if (EndsWith(
".screenshot.pdf"))
1049 if (EndsWith(
".pdf"))
1051 if (EndsWith(
".json"))
1053 if (EndsWith(
".svg"))
1055 if (EndsWith(
".screenshot.png"))
1057 if (EndsWith(
".png"))
1059 if (EndsWith(
".jpg") || EndsWith(
".jpeg"))
1061 if (EndsWith(
".webp"))
1086 std::vector<std::string>
fnames;
1088 if ((
fmt ==
"s.pdf") || (
fmt ==
"s.png")) {
1096 farg.insert(
farg.rfind(
"."),
"%d");
1133 std::vector<std::string>
fmts;
1139 for (
unsigned n = 0; (
n <
fmts.size()) && (
n <
jsons.size());
n++) {
1140 if (
fmts[
n] ==
"json") {
1144 }
else if (!
fmts[
n].empty())
1181 if (
fmts[0] ==
"s.png") {
1183 R__LOG_ERROR(
WebGUILog()) <<
"Direct png image creation supported only by Chrome and Firefox browsers";
1188 }
else if (
fmts[0] ==
"s.pdf") {
1227 std::string
mains, prev;
1231 mains.append(
"'same'");
1242 static std::string
jsroot_include =
"<script id=\"jsroot\" src=\"$jsrootsys/build/jsroot.js\"></script>";
1244 if (
p != std::string::npos) {
1274 fputs(
"placeholder", df);
1320 std::ofstream
ofs(
html_name.Data(), std::ofstream::out);
1351 if (
fmts[0] ==
"s.pdf")
1381 if (
gEnv->
GetValue(
"WebGui.PreserveBatchFiles", -1) > 0)
1393 if (
fmts[0] ==
"s.pdf")
1394 ::Info(
"ProduceImages",
"PDF file %s with %d pages has been created",
fnames[0].c_str(), (
int)
jsons.size());
1398 ::Info(
"ProduceImages",
"PNG file %s with %d pages has been created",
fnames[0].c_str(), (
int)
jsons.size());
1401 auto dumpcont = handle->GetContent();
1416 std::string::size_type
p = 0;
1418 for (
unsigned n = 0;
n <
fmts.size();
n++) {
1419 if (
fmts[
n].empty())
1421 if (
fmts[
n] ==
"svg") {
1426 if ((
p1 != std::string::npos) && (
p2 != std::string::npos) && (
p1 <
p2)) {
1429 ::Info(
"ProduceImages",
"Image file %s size %d bytes has been created",
fnames[
n].c_str(), (
int) (
p2 -
p1 + 1));
1431 ::Error(
"ProduceImages",
"Failure producing %s",
fnames[
n].c_str());
1440 if ((
p0 != std::string::npos) && (
p1 != std::string::npos) && (
p2 != std::string::npos) && (
p1 <
p2)) {
1443 ::Error(
"ProduceImages",
"Failure producing %s",
fnames[
n].c_str());
1446 std::ofstream
ofs(
fnames[
n], std::ios::binary);
1448 ::Info(
"ProduceImages",
"Image file %s size %d bytes has been created",
fnames[
n].c_str(), (
int)
binary.Length());
1451 ::Error(
"ProduceImages",
"Failure producing %s",
fnames[
n].c_str());
#define R__LOG_ERROR(...)
#define R__LOG_DEBUG(DEBUGLEVEL,...)
static void DummyTimeOutHandler(int)
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.
winID h TVirtualViewer3D TVirtualGLPainter p
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t height
R__EXTERN TSystem * gSystem
const_iterator begin() const
const_iterator end() const
Specialized handle to hold information about running browser process Used to correctly cleanup all pr...
RWebBrowserHandle(const std::string &url, const std::string &tmpdir, const std::string &tmpfile, browser_process_id pid)
std::string fTmpDir
temporary directory to delete at the end
RWebBrowserHandle(const std::string &url, const std::string &tmpdir, const std::string &tmpfile, const std::string &dump)
std::string fTmpFile
temporary file to remove
~RWebBrowserHandle() override
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
const std::string & GetRedirectOutput() const
get file name to which web browser output should be redirected
void SetStandalone(bool on=true)
Set standalone mode for running browser, default on When disabled, normal browser window (or just tab...
void SetBatchMode(bool on=true)
set batch mode
RWebDisplayArgs & SetSize(int w, int h)
set preferable web window width and height
RWebDisplayArgs & SetUrl(const std::string &url)
set window url
int GetWidth() const
returns preferable web window width
RWebDisplayArgs & SetPageContent(const std::string &cont)
set window url
int GetY() const
set preferable web window y position
std::string GetFullUrl() const
returns window url with append options
bool IsStandalone() const
Return true if browser should runs in standalone mode.
int GetHeight() const
returns preferable web window height
RWebDisplayArgs & SetBrowserKind(const std::string &kind)
Set browser kind as string argument.
std::string GetCustomExec() const
returns custom executable to start web browser
void SetExtraArgs(const std::string &args)
set extra command line arguments for starting web browser command
bool IsBatchMode() const
returns batch mode
bool IsHeadless() const
returns headless mode
@ kOn
web display enable, first try use embed displays like Qt or CEF, then native browsers and at the end ...
@ kFirefox
Mozilla Firefox browser.
@ kNative
either Chrome or Firefox - both support major functionality
@ kLocal
either CEF or Qt5 - both runs on local display without real http server
@ 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
@ kCEF
Chromium Embedded Framework - local display with CEF libs.
@ kQt5
Qt5 QWebEngine libraries - Chromium code packed in qt5.
@ kQt6
Qt6 QWebEngine libraries - Chromium code packed in qt6.
@ kCustom
custom web browser, execution string should be provided
@ kChrome
Google Chrome browser.
@ kEdge
Microsoft Edge browser (Windows only)
void SetRedirectOutput(const std::string &fname="")
specify file name to which web browser output should be redirected
void SetHeadless(bool on=true)
set headless mode
const std::string & GetExtraArgs() const
get extra command line arguments for starting web browser command
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
std::string fProg
browser executable
std::string fBatchExec
batch execute line
std::string fHeadlessExec
headless execute line
std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args) override
Display given URL in web browser.
std::string fExec
standard execute line
void TestProg(const std::string &nexttry, bool check_std_paths=false)
Check if browser executable exists and can be used.
BrowserCreator(bool custom=true, const std::string &exec="")
Class to handle starting of web-browsers like Chrome or Firefox.
ChromeCreator(bool is_edge=false)
Constructor.
void ProcessGeometry(std::string &, const RWebDisplayArgs &) override
Replace $geometry placeholder with geometry settings Also RWebDisplayArgs::GetExtraArgs() are appende...
std::string MakeProfile(std::string &exec, bool) override
Handle profile argument.
FirefoxCreator()
Constructor.
std::string MakeProfile(std::string &exec, bool batch) override
Create Firefox profile to run independent browser window.
void ProcessGeometry(std::string &, const RWebDisplayArgs &) override
Process window geometry for Firefox.
bool IsActive() const override
Returns true if it can be used.
SafariCreator()
Constructor.
Handle of created web-based display Depending from type of web display, holds handle of started brows...
static std::map< std::string, std::unique_ptr< Creator > > & GetMap()
Static holder of registered creators of web displays.
static bool CheckIfCanProduceImages(RWebDisplayArgs &args)
Checks if configured browser can be used for image production.
static bool ProduceImages(const std::string &fname, const std::vector< std::string > &jsons, const std::vector< int > &widths, const std::vector< int > &heights, const char *batch_file=nullptr)
Produce image file(s) using JSON data as source Invokes JSROOT drawing functionality in headless brow...
static std::vector< std::string > ProduceImagesNames(const std::string &fname, unsigned nfiles=1)
Produce vector of file names for specified file pattern Depending from supported file forma.
static std::string GetImageFormat(const std::string &fname)
Detect image format There is special handling of ".screenshot.pdf" and ".screenshot....
void SetContent(const std::string &cont)
set content
static bool ProduceImage(const std::string &fname, const std::string &json, int width=800, int height=600, const char *batch_file=nullptr)
Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser...
static bool CanProduceImages(const std::string &browser="")
Returns true if image production for specified browser kind is supported If browser not specified - u...
static bool NeedHttpServer(const RWebDisplayArgs &args)
Check if http server required for display.
static bool DisplayUrl(const std::string &url)
Display provided url in configured web browser.
static std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args)
Create web display.
static std::unique_ptr< Creator > & FindCreator(const std::string &name, const std::string &libname="")
Search for specific browser creator If not found, try to add one.
static TString Decode(const char *data)
Decode a base64 string date into a generic TString.
static TString ToJSON(const T *obj, Int_t compact=0, const char *member_name=nullptr)
@ kNoSpaces
no new lines plus remove all spaces around "," and ":" symbols
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
static char * ReadFileContent(const char *filename, Int_t &len)
Reads content of file from the disk.
virtual Bool_t InheritsFrom(const char *classname) const
Returns kTRUE if object inherits from class "classname".
static const TString & GetEtcDir()
Get the sysconfig directory in the installation. Static utility function.
static const TString & GetDataDir()
Get the data directory in the installation. Static utility function.
Random number generator class based on M.
TObjArray * Tokenize(const TString &delim) const
This function is used to isolate sequential tokens in a TString.
static TString Format(const char *fmt,...)
Static method which formats a string using a printf style format descriptor and return a TString.
virtual FILE * TempFileName(TString &base, const char *dir=nullptr, const char *suffix=nullptr)
Create a secure temporary file by appending a unique 6 letter string to base.
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 mkdir(const char *name, Bool_t recursive=kFALSE)
Make a file system directory.
virtual Int_t Exec(const char *shellcmd)
Execute a command.
virtual int Load(const char *module, const char *entry="", Bool_t system=kFALSE)
Load a shared library.
virtual const char * PrependPathName(const char *dir, TString &name)
Concatenate a directory and a file name.
virtual Bool_t AccessPathName(const char *path, EAccessMode mode=kFileExists)
Returns FALSE if one can access a file using the specified access mode.
virtual std::string GetHomeDirectory(const char *userName=nullptr) const
Return the user's home directory.
virtual const char * UnixPathName(const char *unixpathname)
Convert from a local pathname to a Unix pathname.
virtual int Rename(const char *from, const char *to)
Rename a file.
virtual TString GetFromPipe(const char *command, Int_t *ret=nullptr, Bool_t redirectStderr=kFALSE)
Execute command and return output in TString.
virtual Bool_t IsAbsoluteFileName(const char *dir)
Return true if dir is an absolute pathname.
virtual const char * WorkingDirectory()
Return working directory.
virtual int Unlink(const char *name)
Unlink, i.e.
virtual const char * TempDirectory() const
Return a user configured or systemwide directory to create temporary files in.
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
ROOT::RLogChannel & WebGUILog()
Log channel for WebGUI diagnostics.