Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RWebDisplayHandle.cxx
Go to the documentation of this file.
1// Author: Sergey Linev <s.linev@gsi.de>
2// Date: 2018-10-17
3// Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
4
5/*************************************************************************
6 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
7 * All rights reserved. *
8 * *
9 * For the licensing terms see $ROOTSYS/LICENSE. *
10 * For the list of contributors see $ROOTSYS/README/CREDITS. *
11 *************************************************************************/
12
14
15#include <ROOT/RLogger.hxx>
16
17#include "RConfigure.h"
18#include "TSystem.h"
19#include "TRandom.h"
20#include "TString.h"
21#include "TObjArray.h"
22#include "THttpServer.h"
23#include "TEnv.h"
24#include "TError.h"
25#include "TROOT.h"
26#include "TBase64.h"
27#include "TBufferJSON.h"
28
29#include <fstream>
30#include <iostream>
31#include <filesystem>
32#include <memory>
33#include <regex>
34
35#ifdef _MSC_VER
36#include <process.h>
37#else
38#include <unistd.h>
39#include <stdlib.h>
40#include <signal.h>
41#include <spawn.h>
42#endif
43
44using namespace ROOT;
45using namespace std::string_literals;
46
47/** \class ROOT::RWebDisplayHandle
48\ingroup webdisplay
49
50Handle of created web-based display
51Depending from type of web display, holds handle of started browser process or other display-specific information
52to correctly stop and cleanup display.
53*/
54
55
56//////////////////////////////////////////////////////////////////////////////////////////////////
57/// Static holder of registered creators of web displays
58
59std::map<std::string, std::unique_ptr<RWebDisplayHandle::Creator>> &RWebDisplayHandle::GetMap()
60{
61 static std::map<std::string, std::unique_ptr<RWebDisplayHandle::Creator>> sMap;
62 return sMap;
63}
64
65//////////////////////////////////////////////////////////////////////////////////////////////////
66/// Search for specific browser creator
67/// If not found, try to add one
68/// \param name - creator name like ChromeCreator
69/// \param libname - shared library name where creator could be provided
70
71std::unique_ptr<RWebDisplayHandle::Creator> &RWebDisplayHandle::FindCreator(const std::string &name, const std::string &libname)
72{
73 auto &m = GetMap();
74 auto search = m.find(name);
75 if (search == m.end()) {
76
77 if (libname == "ChromeCreator") {
78 m.emplace(name, std::make_unique<ChromeCreator>(name == "edge"));
79 } else if (libname == "FirefoxCreator") {
80 m.emplace(name, std::make_unique<FirefoxCreator>());
81 } else if (libname == "SafariCreator") {
82 m.emplace(name, std::make_unique<SafariCreator>());
83 } else if (libname == "BrowserCreator") {
84 m.emplace(name, std::make_unique<BrowserCreator>(false));
85 } else if (!libname.empty()) {
86 gSystem->Load(libname.c_str());
87 }
88
89 search = m.find(name); // try again
90 }
91
92 if (search != m.end())
93 return search->second;
94
95 static std::unique_ptr<RWebDisplayHandle::Creator> dummy;
96 return dummy;
97}
98
99namespace ROOT {
100
101//////////////////////////////////////////////////////////////////////////////////////////////////
102/// Specialized handle to hold information about running browser process
103/// Used to correctly cleanup all processes and temporary directories
104
106
107#ifdef _MSC_VER
108 typedef int browser_process_id;
109#else
110 typedef pid_t browser_process_id;
111#endif
112 std::string fTmpDir; ///< temporary directory to delete at the end
113 std::string fTmpFile; ///< temporary file to remove
114 bool fHasPid{false};
116
117public:
118 RWebBrowserHandle(const std::string &url, const std::string &tmpdir, const std::string &tmpfile, const std::string &dump) :
119 RWebDisplayHandle(url), fTmpDir(tmpdir), fTmpFile(tmpfile)
120 {
121 SetContent(dump);
122 }
123
124 RWebBrowserHandle(const std::string &url, const std::string &tmpdir, const std::string &tmpfile, browser_process_id pid)
125 : RWebDisplayHandle(url), fTmpDir(tmpdir), fTmpFile(tmpfile), fHasPid(true), fPid(pid)
126 {
127 }
128
130 {
131#ifdef _MSC_VER
132 if (fHasPid)
133 gSystem->Exec(("taskkill /F /PID "s + std::to_string(fPid) + " >NUL 2>NUL").c_str());
134 std::string rmdir = "rmdir /S /Q ", rmfile = "del /F ";
135#else
136 if (fHasPid)
137 kill(fPid, SIGKILL);
138 std::string rmdir = "rm -rf ", rmfile = "rm -f ";
139#endif
140 if (!fTmpDir.empty())
141 gSystem->Exec((rmdir + fTmpDir).c_str());
142 if (!fTmpFile.empty())
143 gSystem->Exec((rmfile + fTmpFile).c_str());
144 }
145
146};
147
148} // namespace ROOT
149
150//////////////////////////////////////////////////////////////////////////////////////////////////
151/// Class to handle starting of web-browsers like Chrome or Firefox
152
153RWebDisplayHandle::BrowserCreator::BrowserCreator(bool custom, const std::string &exec)
154{
155 if (custom) return;
156
157 if (!exec.empty()) {
158 if (exec.find("$url") == std::string::npos) {
159 fProg = exec;
160#ifdef _MSC_VER
161 fExec = exec + " $url";
162#else
163 fExec = exec + " $url &";
164#endif
165 } else {
166 fExec = exec;
167 auto pos = exec.find(" ");
168 if (pos != std::string::npos)
169 fProg = exec.substr(0, pos);
170 }
171 } else if (gSystem->InheritsFrom("TMacOSXSystem")) {
172 fExec = "open \'$url\'";
173 } else if (gSystem->InheritsFrom("TWinNTSystem")) {
174 fExec = "start $url";
175 } else {
176 fExec = "xdg-open \'$url\' &";
177 }
178}
179
180//////////////////////////////////////////////////////////////////////////////////////////////////
181/// Check if browser executable exists and can be used
182
183void RWebDisplayHandle::BrowserCreator::TestProg(const std::string &nexttry, bool check_std_paths)
184{
185 if (nexttry.empty() || !fProg.empty())
186 return;
187
188 if (!gSystem->AccessPathName(nexttry.c_str(), kExecutePermission)) {
189#ifdef R__MACOSX
190 fProg = std::regex_replace(nexttry, std::regex("%20"), " ");
191#else
192 fProg = nexttry;
193#endif
194 return;
195 }
196
197 if (!check_std_paths)
198 return;
199
200#ifdef _MSC_VER
201 std::string ProgramFiles = gSystem->Getenv("ProgramFiles");
202 auto pos = ProgramFiles.find(" (x86)");
203 if (pos != std::string::npos)
204 ProgramFiles.erase(pos, 6);
205 std::string ProgramFilesx86 = gSystem->Getenv("ProgramFiles(x86)");
206
207 if (!ProgramFiles.empty())
208 TestProg(ProgramFiles + nexttry, false);
209 if (!ProgramFilesx86.empty())
210 TestProg(ProgramFilesx86 + nexttry, false);
211#endif
212}
213
214//////////////////////////////////////////////////////////////////////////////////////////////////
215/// Display given URL in web browser
216
217std::unique_ptr<RWebDisplayHandle>
219{
220 std::string url = args.GetFullUrl();
221 if (url.empty())
222 return nullptr;
223
225 std::cout << "New web window: " << url << std::endl;
226 return std::make_unique<RWebBrowserHandle>(url, "", "", "");
227 }
228
229 std::string exec;
230 if (args.IsBatchMode())
231 exec = fBatchExec;
232 else if (args.IsHeadless())
233 exec = fHeadlessExec;
234 else if (args.IsStandalone())
235 exec = fExec;
236 else
237 exec = "$prog $url &";
238
239 if (exec.empty())
240 return nullptr;
241
242 std::string swidth = std::to_string(args.GetWidth() > 0 ? args.GetWidth() : 800),
243 sheight = std::to_string(args.GetHeight() > 0 ? args.GetHeight() : 600),
244 sposx = std::to_string(args.GetX() >= 0 ? args.GetX() : 0),
245 sposy = std::to_string(args.GetY() >= 0 ? args.GetY() : 0);
246
247 ProcessGeometry(exec, args);
248
249 std::string rmdir = MakeProfile(exec, args.IsBatchMode() || args.IsHeadless());
250
251 std::string tmpfile;
252
253 // these are secret parameters, hide them in temp file
254 if (((url.find("token=") != std::string::npos) || (url.find("key=") != std::string::npos)) && !args.IsBatchMode() && !args.IsHeadless()) {
255 TString filebase = "root_start_";
256
257 auto f = gSystem->TempFileName(filebase, nullptr, ".html");
258
259 bool ferr = false;
260
261 if (!f) {
262 ferr = true;
263 } else {
264 std::string content = std::regex_replace(
265 "<!DOCTYPE html>\n"
266 "<html lang=\"en\">\n"
267 "<head>\n"
268 " <meta charset=\"utf-8\">\n"
269 " <meta http-equiv=\"refresh\" content=\"0;url=$url\"/>\n"
270 " <title>Opening ROOT widget</title>\n"
271 "</head>\n"
272 "<body>\n"
273 "<p>\n"
274 " This page should redirect you to a ROOT widget. If it doesn't,\n"
275 " <a href=\"$url\">click here to go to ROOT</a>.\n"
276 "</p>\n"
277 "</body>\n"
278 "</html>\n", std::regex("\\$url"), url);
279
280 if (fwrite(content.c_str(), 1, content.length(), f) != content.length())
281 ferr = true;
282
283 if (fclose(f) != 0)
284 ferr = true;
285
286 tmpfile = filebase.Data();
287
288 url = "file://"s + tmpfile;
289 }
290
291 if (ferr) {
292 if (!tmpfile.empty())
293 gSystem->Unlink(tmpfile.c_str());
294 R__LOG_ERROR(WebGUILog()) << "Fail to create temporary HTML file to startup widget";
295 return nullptr;
296 }
297 }
298
299 exec = std::regex_replace(exec, std::regex("\\$rootetcdir"), TROOT::GetEtcDir().Data());
300 exec = std::regex_replace(exec, std::regex("\\$url"), url);
301 exec = std::regex_replace(exec, std::regex("\\$width"), swidth);
302 exec = std::regex_replace(exec, std::regex("\\$height"), sheight);
303 exec = std::regex_replace(exec, std::regex("\\$posx"), sposx);
304 exec = std::regex_replace(exec, std::regex("\\$posy"), sposy);
305
306 if (exec.compare(0,5,"fork:") == 0) {
307 if (fProg.empty()) {
308 if (!tmpfile.empty())
309 gSystem->Unlink(tmpfile.c_str());
310 R__LOG_ERROR(WebGUILog()) << "Fork instruction without executable";
311 return nullptr;
312 }
313
314 exec.erase(0, 5);
315
316#ifndef _MSC_VER
317
318 std::unique_ptr<TObjArray> fargs(TString(exec.c_str()).Tokenize(" "));
319 if (!fargs || (fargs->GetLast()<=0)) {
320 if (!tmpfile.empty())
321 gSystem->Unlink(tmpfile.c_str());
322 R__LOG_ERROR(WebGUILog()) << "Fork instruction is empty";
323 return nullptr;
324 }
325
326 std::vector<char *> argv;
327 argv.push_back((char *) fProg.c_str());
328 for (Int_t n = 0; n <= fargs->GetLast(); ++n)
329 argv.push_back((char *)fargs->At(n)->GetName());
330 argv.push_back(nullptr);
331
332 R__LOG_DEBUG(0, WebGUILog()) << "Show web window in browser with posix_spawn:\n" << fProg << " " << exec;
333
334 pid_t pid;
335 int status = posix_spawn(&pid, argv[0], nullptr, nullptr, argv.data(), nullptr);
336 if (status != 0) {
337 if (!tmpfile.empty())
338 gSystem->Unlink(tmpfile.c_str());
339 R__LOG_ERROR(WebGUILog()) << "Fail to launch " << argv[0];
340 return nullptr;
341 }
342
343 // add processid and rm dir
344
345 return std::make_unique<RWebBrowserHandle>(url, rmdir, tmpfile, pid);
346
347#else
348
349 if (fProg.empty()) {
350 if (!tmpfile.empty())
351 gSystem->Unlink(tmpfile.c_str());
352 R__LOG_ERROR(WebGUILog()) << "No Web browser found";
353 return nullptr;
354 }
355
356 // use UnixPathName to simplify handling of backslashes
357 exec = "wmic process call create '"s + gSystem->UnixPathName(fProg.c_str()) + " " + exec + "' | find \"ProcessId\" "s;
358 std::string process_id = gSystem->GetFromPipe(exec.c_str()).Data();
359 std::stringstream ss(process_id);
360 std::string tmp;
361 char c;
362 int pid = 0;
363 ss >> tmp >> c >> pid;
364
365 if (pid <= 0) {
366 if (!tmpfile.empty())
367 gSystem->Unlink(tmpfile.c_str());
368 R__LOG_ERROR(WebGUILog()) << "Fail to launch " << fProg;
369 return nullptr;
370 }
371
372 // add processid and rm dir
373 return std::make_unique<RWebBrowserHandle>(url, rmdir, tmpfile, pid);
374#endif
375 }
376
377#ifdef _MSC_VER
378
379 if (exec.rfind("&") == exec.length() - 1) {
380
381 // if last symbol is &, use _spawn to detach execution
382 exec.resize(exec.length() - 1);
383
384 std::vector<char *> argv;
385 std::string firstarg = fProg;
386 auto slashpos = firstarg.find_last_of("/\\");
387 if (slashpos != std::string::npos)
388 firstarg.erase(0, slashpos + 1);
389 argv.push_back((char *)firstarg.c_str());
390
391 std::unique_ptr<TObjArray> fargs(TString(exec.c_str()).Tokenize(" "));
392 for (Int_t n = 1; n <= fargs->GetLast(); ++n)
393 argv.push_back((char *)fargs->At(n)->GetName());
394 argv.push_back(nullptr);
395
396 R__LOG_DEBUG(0, WebGUILog()) << "Showing web window in " << fProg << " with:\n" << exec;
397
398 _spawnv(_P_NOWAIT, gSystem->UnixPathName(fProg.c_str()), argv.data());
399
400 return std::make_unique<RWebBrowserHandle>(url, rmdir, tmpfile, ""s);
401 }
402
403 std::string prog = "\""s + gSystem->UnixPathName(fProg.c_str()) + "\""s;
404
405#else
406
407#ifdef R__MACOSX
408 std::string prog = std::regex_replace(fProg, std::regex(" "), "\\ ");
409#else
410 std::string prog = fProg;
411#endif
412
413#endif
414
415 exec = std::regex_replace(exec, std::regex("\\$prog"), prog);
416
417 std::string redirect = args.GetRedirectOutput(), dump_content;
418
419 if (!redirect.empty()) {
420 if (exec.find("$dumpfile") != std::string::npos) {
421 exec = std::regex_replace(exec, std::regex("\\$dumpfile"), redirect);
422 } else {
423 auto p = exec.length();
424 if (exec.rfind("&") == p-1) --p;
425 exec.insert(p, " >"s + redirect + " "s);
426 }
427 }
428
429 R__LOG_DEBUG(0, WebGUILog()) << "Showing web window in browser with:\n" << exec;
430
431 gSystem->Exec(exec.c_str());
432
433 // read content of redirected output
434 if (!redirect.empty()) {
435 dump_content = THttpServer::ReadFileContent(redirect.c_str());
436
437 if (gEnv->GetValue("WebGui.PreserveBatchFiles", -1) > 0)
438 ::Info("RWebDisplayHandle::Display", "Preserve dump file %s", redirect.c_str());
439 else
440 gSystem->Unlink(redirect.c_str());
441 }
442
443 return std::make_unique<RWebBrowserHandle>(url, rmdir, tmpfile, dump_content);
444}
445
446//////////////////////////////////////////////////////////////////////////////////////////////////
447/// Constructor
448
450{
451 fExec = gEnv->GetValue("WebGui.SafariInteractive", "open -a Safari $url");
452}
453
454//////////////////////////////////////////////////////////////////////////////////////////////////
455/// Returns true if it can be used
456
458{
459#ifdef R__MACOSX
460 return true;
461#else
462 return false;
463#endif
464}
465
466//////////////////////////////////////////////////////////////////////////////////////////////////
467/// Constructor
468
470{
471 fEdge = _edge;
472
473 fEnvPrefix = fEdge ? "WebGui.Edge" : "WebGui.Chrome";
474
475 TestProg(gEnv->GetValue(fEnvPrefix.c_str(), ""));
476
477 if (!fProg.empty() && !fEdge)
478 fChromeVersion = gEnv->GetValue("WebGui.ChromeVersion", -1);
479
480#ifdef _MSC_VER
481 if (fEdge)
482 TestProg("\\Microsoft\\Edge\\Application\\msedge.exe", true);
483 else
484 TestProg("\\Google\\Chrome\\Application\\chrome.exe", true);
485#endif
486#ifdef R__MACOSX
487 TestProg("/Applications/Google Chrome.app/Contents/MacOS/Google Chrome");
488#endif
489#ifdef R__LINUX
490 TestProg("/usr/bin/chromium");
491 TestProg("/usr/bin/chromium-browser");
492 TestProg("/usr/bin/chrome-browser");
493 TestProg("/usr/bin/google-chrome-stable");
494 TestProg("/usr/bin/google-chrome");
495#endif
496
497// --no-sandbox is required to run chrome with super-user, but only in headless mode
498
499#ifdef _MSC_VER
500 // here --headless=old required to let normally end of Edge process when --dump-dom is used
501 fBatchExec = gEnv->GetValue((fEnvPrefix + "Batch").c_str(), "$prog --headless=old --no-sandbox $geometry --dump-dom $url");
502 // in interactive headless mode fork used to let stop browser via process id
503 fHeadlessExec = gEnv->GetValue((fEnvPrefix + "Headless").c_str(), "fork:--headless=old --no-sandbox --disable-gpu $geometry \"$url\"");
504 fExec = gEnv->GetValue((fEnvPrefix + "Interactive").c_str(), "$prog $geometry --new-window --app=$url &"); // & in windows mean usage of spawn
505#else
506#ifdef R__MACOSX
507 bool use_normal = true; // mac does not like new flag
508#else
509 bool use_normal = fChromeVersion < 119;
510#endif
511 if (use_normal) {
512 // old browser with standard headless mode
513 fBatchExec = gEnv->GetValue((fEnvPrefix + "Batch").c_str(), "$prog --headless --no-sandbox --disable-extensions --disable-audio-output $geometry --dump-dom $url 2>/dev/null");
514 fHeadlessExec = gEnv->GetValue((fEnvPrefix + "Headless").c_str(), "$prog --headless --no-sandbox --disable-extensions --disable-audio-output $geometry \'$url\' >/dev/null 2>/dev/null &");
515 } else {
516 // newer version with headless=new mode
517 fBatchExec = gEnv->GetValue((fEnvPrefix + "Batch").c_str(), "$prog --headless=new --no-sandbox --disable-extensions --disable-audio-output $geometry --dump-dom $url 2>/dev/null");
518 fHeadlessExec = gEnv->GetValue((fEnvPrefix + "Headless").c_str(), "$prog --headless=new --no-sandbox --disable-extensions --disable-audio-output $geometry \'$url\' >/dev/null 2>/dev/null &");
519 }
520 fExec = gEnv->GetValue((fEnvPrefix + "Interactive").c_str(), "$prog $geometry --new-window --app=\'$url\' >/dev/null 2>/dev/null &");
521#endif
522}
523
524
525//////////////////////////////////////////////////////////////////////////////////////////////////
526/// Replace $geometry placeholder with geometry settings
527/// Also RWebDisplayArgs::GetExtraArgs() are appended
528
530{
531 std::string geometry;
532 if ((args.GetWidth() > 0) && (args.GetHeight() > 0))
533 geometry = "--window-size="s + std::to_string(args.GetWidth())
534 + (args.IsHeadless() ? "x"s : ","s)
535 + std::to_string(args.GetHeight());
536
537 if (((args.GetX() >= 0) || (args.GetY() >= 0)) && !args.IsHeadless()) {
538 if (!geometry.empty()) geometry.append(" ");
539 geometry.append("--window-position="s + std::to_string(args.GetX() >= 0 ? args.GetX() : 0) + ","s +
540 std::to_string(args.GetY() >= 0 ? args.GetY() : 0));
541 }
542
543 if (!args.GetExtraArgs().empty()) {
544 if (!geometry.empty()) geometry.append(" ");
545 geometry.append(args.GetExtraArgs());
546 }
547
548 exec = std::regex_replace(exec, std::regex("\\$geometry"), geometry);
549}
550
551
552//////////////////////////////////////////////////////////////////////////////////////////////////
553/// Handle profile argument
554
555std::string RWebDisplayHandle::ChromeCreator::MakeProfile(std::string &exec, bool)
556{
557 std::string rmdir, profile_arg;
558
559 if (exec.find("$profile") == std::string::npos)
560 return rmdir;
561
562 const char *chrome_profile = gEnv->GetValue((fEnvPrefix + "Profile").c_str(), "");
563 if (chrome_profile && *chrome_profile) {
564 profile_arg = chrome_profile;
565 } else {
566 gRandom->SetSeed(0);
567 profile_arg = gSystem->TempDirectory();
568#ifdef _MSC_VER
569 char slash = '\\';
570#else
571 char slash = '/';
572#endif
573 if (!profile_arg.empty() && (profile_arg[profile_arg.length()-1] != slash))
574 profile_arg += slash;
575 profile_arg += "root_chrome_profile_"s + std::to_string(gRandom->Integer(0x100000));
576
577 rmdir = profile_arg;
578 }
579
580 exec = std::regex_replace(exec, std::regex("\\$profile"), profile_arg);
581
582 return rmdir;
583}
584
585
586//////////////////////////////////////////////////////////////////////////////////////////////////
587/// Constructor
588
590{
591 TestProg(gEnv->GetValue("WebGui.Firefox", ""));
592
593#ifdef _MSC_VER
594 TestProg("\\Mozilla Firefox\\firefox.exe", true);
595#endif
596#ifdef R__MACOSX
597 TestProg("/Applications/Firefox.app/Contents/MacOS/firefox");
598#endif
599#ifdef R__LINUX
600 TestProg("/usr/bin/firefox");
601 TestProg("/usr/bin/firefox-bin");
602#endif
603
604#ifdef _MSC_VER
605 // there is a problem when specifying the window size with wmic on windows:
606 // It gives: Invalid format. Hint: <paramlist> = <param> [, <paramlist>].
607 fBatchExec = gEnv->GetValue("WebGui.FirefoxBatch", "$prog -headless -no-remote $profile $url");
608 fHeadlessExec = gEnv->GetValue("WebGui.FirefoxHeadless", "fork:-headless -no-remote $profile \"$url\"");
609 fExec = gEnv->GetValue("WebGui.FirefoxInteractive", "$prog -no-remote $profile $geometry $url &");
610#else
611 fBatchExec = gEnv->GetValue("WebGui.FirefoxBatch", "$rootetcdir/runfirefox.sh $dumpfile $cleanup_profile $prog --headless -no-remote -new-instance $profile $url 2>/dev/null");
612 fHeadlessExec = gEnv->GetValue("WebGui.FirefoxHeadless", "fork:--headless -no-remote $profile --private-window $url");
613 fExec = gEnv->GetValue("WebGui.FirefoxInteractive", "$rootetcdir/runfirefox.sh __nodump__ $cleanup_profile $prog -no-remote $profile $geometry -url \'$url\' &");
614#endif
615}
616
617//////////////////////////////////////////////////////////////////////////////////////////////////
618/// Process window geometry for Firefox
619
621{
622 std::string geometry;
623 if ((args.GetWidth() > 0) && (args.GetHeight() > 0) && !args.IsHeadless())
624 geometry = "-width="s + std::to_string(args.GetWidth()) + " -height=" + std::to_string(args.GetHeight());
625
626 exec = std::regex_replace(exec, std::regex("\\$geometry"), geometry);
627}
628
629//////////////////////////////////////////////////////////////////////////////////////////////////
630/// Create Firefox profile to run independent browser window
631
632std::string RWebDisplayHandle::FirefoxCreator::MakeProfile(std::string &exec, bool batch_mode)
633{
634 std::string rmdir, profile_arg;
635
636 if (exec.find("$profile") == std::string::npos)
637 return rmdir;
638
639 const char *ff_profile = gEnv->GetValue("WebGui.FirefoxProfile", "");
640 const char *ff_profilepath = gEnv->GetValue("WebGui.FirefoxProfilePath", "");
641 Int_t ff_randomprofile = gEnv->GetValue("WebGui.FirefoxRandomProfile", (Int_t) 1);
642 if (ff_profile && *ff_profile) {
643 profile_arg = "-P "s + ff_profile;
644 } else if (ff_profilepath && *ff_profilepath) {
645 profile_arg = "-profile "s + ff_profilepath;
646 } else if (ff_randomprofile > 0) {
647
648 gRandom->SetSeed(0);
649 std::string profile_dir = gSystem->TempDirectory();
650
651#ifdef _MSC_VER
652 char slash = '\\';
653#else
654 char slash = '/';
655#endif
656 if (!profile_dir.empty() && (profile_dir[profile_dir.length()-1] != slash))
657 profile_dir += slash;
658 profile_dir += "root_ff_profile_"s + std::to_string(gRandom->Integer(0x100000));
659
660 profile_arg = "-profile "s + profile_dir;
661
662 if (gSystem->mkdir(profile_dir.c_str()) == 0) {
663 rmdir = profile_dir;
664
665 std::ofstream user_js(profile_dir + "/user.js", std::ios::trunc);
666 // workaround for current Firefox, without such settings it fail to close window and terminate it from batch
667 // also disable question about upload of data
668 user_js << "user_pref(\"datareporting.policy.dataSubmissionPolicyAcceptedVersion\", 2);" << std::endl;
669 user_js << "user_pref(\"datareporting.policy.dataSubmissionPolicyNotifiedTime\", \"1635760572813\");" << std::endl;
670
671 // try to ensure that window closes with last tab
672 user_js << "user_pref(\"browser.tabs.closeWindowWithLastTab\", true);" << std::endl;
673 user_js << "user_pref(\"dom.allow_scripts_to_close_windows\", true);" << std::endl;
674 user_js << "user_pref(\"browser.sessionstore.resume_from_crash\", false);" << std::endl;
675
676 if (batch_mode) {
677 // allow to dump messages to std output
678 user_js << "user_pref(\"browser.dom.window.dump.enabled\", true);" << std::endl;
679 } else {
680 // to suppress annoying privacy tab
681 user_js << "user_pref(\"datareporting.policy.firstRunURL\", \"\");" << std::endl;
682 // to use custom userChrome.css files
683 user_js << "user_pref(\"toolkit.legacyUserProfileCustomizations.stylesheets\", true);" << std::endl;
684 // do not put tabs in title
685 user_js << "user_pref(\"browser.tabs.inTitlebar\", 0);" << std::endl;
686
687 std::ofstream times_json(profile_dir + "/times.json", std::ios::trunc);
688 times_json << "{" << std::endl;
689 times_json << " \"created\": 1699968480952," << std::endl;
690 times_json << " \"firstUse\": null" << std::endl;
691 times_json << "}" << std::endl;
692 if (gSystem->mkdir((profile_dir + "/chrome").c_str()) == 0) {
693 std::ofstream style(profile_dir + "/chrome/userChrome.css", std::ios::trunc);
694 // do not show tabs
695 style << "#TabsToolbar { visibility: collapse; }" << std::endl;
696 // do not show URL
697 style << "#nav-bar, #urlbar-container, #searchbar { visibility: collapse !important; }" << std::endl;
698 }
699 }
700
701 } else {
702 R__LOG_ERROR(WebGUILog()) << "Cannot create Firefox profile directory " << profile_dir;
703 }
704 }
705
706 exec = std::regex_replace(exec, std::regex("\\$profile"), profile_arg);
707
708 if (exec.find("$cleanup_profile") != std::string::npos) {
709 if (rmdir.empty()) rmdir = "__dummy__";
710 exec = std::regex_replace(exec, std::regex("\\$cleanup_profile"), rmdir);
711 rmdir.clear(); // no need to delete directory - it will be removed by script
712 }
713
714 return rmdir;
715}
716
717///////////////////////////////////////////////////////////////////////////////////////////////////
718/// Check if http server required for display
719/// \param args - defines where and how to display web window
720
722{
726 return false;
727
728 if (!args.IsHeadless() && (args.GetBrowserKind() == RWebDisplayArgs::kOn)) {
729
730#ifdef WITH_QT6WEB
731 auto &qt6 = FindCreator("qt6", "libROOTQt6WebDisplay");
732 if (qt6 && qt6->IsActive())
733 return false;
734#endif
735#ifdef WITH_QT5WEB
736 auto &qt5 = FindCreator("qt5", "libROOTQt5WebDisplay");
737 if (qt5 && qt5->IsActive())
738 return false;
739#endif
740#ifdef WITH_CEFWEB
741 auto &cef = FindCreator("cef", "libROOTCefDisplay");
742 if (cef && cef->IsActive())
743 return false;
744#endif
745 }
746
747 return true;
748}
749
750
751///////////////////////////////////////////////////////////////////////////////////////////////////
752/// Create web display
753/// \param args - defines where and how to display web window
754/// Returns RWebDisplayHandle, which holds information of running browser application
755/// Can be used fully independent from RWebWindow classes just to show any web page
756
757std::unique_ptr<RWebDisplayHandle> RWebDisplayHandle::Display(const RWebDisplayArgs &args)
758{
759 std::unique_ptr<RWebDisplayHandle> handle;
760
762 return handle;
763
764 auto try_creator = [&](std::unique_ptr<Creator> &creator) {
765 if (!creator || !creator->IsActive())
766 return false;
767 handle = creator->Display(args);
768 return handle ? true : false;
769 };
770
771 bool handleAsLocal = (args.GetBrowserKind() == RWebDisplayArgs::kLocal) ||
772 (!args.IsHeadless() && (args.GetBrowserKind() == RWebDisplayArgs::kOn)),
773 has_qt5web = false, has_qt6web = false, has_cefweb = false;
774
775#ifdef WITH_QT5WEB
776 has_qt5web = true;
777#endif
778
779#ifdef WITH_QT6WEB
780 has_qt6web = true;
781#endif
782
783#ifdef WITH_CEFWEB
784 has_cefweb = true;
785#endif
786
787 if ((handleAsLocal && has_qt6web) || (args.GetBrowserKind() == RWebDisplayArgs::kQt6)) {
788 if (try_creator(FindCreator("qt6", "libROOTQt6WebDisplay")))
789 return handle;
790 }
791
792 // qt5 uses older chromium therefore do not invoke by default
793 if (has_qt5web && (args.GetBrowserKind() == RWebDisplayArgs::kQt5)) {
794 if (try_creator(FindCreator("qt5", "libROOTQt5WebDisplay")))
795 return handle;
796 }
797
798 if ((handleAsLocal && has_cefweb) || (args.GetBrowserKind() == RWebDisplayArgs::kCEF)) {
799 if (try_creator(FindCreator("cef", "libROOTCefDisplay")))
800 return handle;
801 }
802
803 if (args.IsLocalDisplay()) {
804 R__LOG_ERROR(WebGUILog()) << "Neither Qt5/6 nor CEF libraries were found to provide local display";
805 return handle;
806 }
807
808 bool handleAsNative =
810
811 if (handleAsNative || (args.GetBrowserKind() == RWebDisplayArgs::kChrome)) {
812 if (try_creator(FindCreator("chrome", "ChromeCreator")))
813 return handle;
814 }
815
816 if (handleAsNative || (args.GetBrowserKind() == RWebDisplayArgs::kFirefox)) {
817 if (try_creator(FindCreator("firefox", "FirefoxCreator")))
818 return handle;
819 }
820
821#ifdef _MSC_VER
822 // Edge browser cannot be run headless without registry change, therefore do not try it by default
823 if ((handleAsNative && !args.IsHeadless() && !args.IsBatchMode()) || (args.GetBrowserKind() == RWebDisplayArgs::kEdge)) {
824 if (try_creator(FindCreator("edge", "ChromeCreator")))
825 return handle;
826 }
827#endif
828
831 // R__LOG_ERROR(WebGUILog()) << "Neither Chrome nor Firefox browser cannot be started to provide display";
832 return handle;
833 }
834
836 if (try_creator(FindCreator("safari", "SafariCreator")))
837 return handle;
838 }
839
841 std::unique_ptr<Creator> creator = std::make_unique<BrowserCreator>(false, args.GetCustomExec());
842 try_creator(creator);
843 } else {
844 try_creator(FindCreator("browser", "BrowserCreator"));
845 }
846
847 return handle;
848}
849
850///////////////////////////////////////////////////////////////////////////////////////////////////
851/// Display provided url in configured web browser
852/// \param url - specified URL address like https://root.cern
853/// Browser can specified when starting `root --web=firefox`
854/// Returns true when browser started
855/// It is convenience method, equivalent to:
856/// ~~~
857/// RWebDisplayArgs args;
858/// args.SetUrl(url);
859/// args.SetStandalone(false);
860/// auto handle = RWebDisplayHandle::Display(args);
861/// ~~~
862
863bool RWebDisplayHandle::DisplayUrl(const std::string &url)
864{
865 RWebDisplayArgs args;
866 args.SetUrl(url);
867 args.SetStandalone(false);
868
869 auto handle = Display(args);
870
871 return !!handle;
872}
873
874///////////////////////////////////////////////////////////////////////////////////////////////////
875/// Checks if configured browser can be used for image production
876
878{
882 bool detected = false;
883
884 auto &h1 = FindCreator("chrome", "ChromeCreator");
885 if (h1 && h1->IsActive()) {
887 detected = true;
888 }
889
890 if (!detected) {
891 auto &h2 = FindCreator("firefox", "FirefoxCreator");
892 if (h2 && h2->IsActive()) {
894 detected = true;
895 }
896 }
897
898 return detected;
899 }
900
902 auto &h1 = FindCreator("chrome", "ChromeCreator");
903 return h1 && h1->IsActive();
904 }
905
907 auto &h2 = FindCreator("firefox", "FirefoxCreator");
908 return h2 && h2->IsActive();
909 }
910
911#ifdef _MSC_VER
913 auto &h3 = FindCreator("edge", "ChromeCreator");
914 return h3 && h3->IsActive();
915 }
916#endif
917
918 return true;
919}
920
921///////////////////////////////////////////////////////////////////////////////////////////////////
922/// Returns true if image production for specified browser kind is supported
923/// If browser not specified - use currently configured browser or try to test existing web browsers
924
925bool RWebDisplayHandle::CanProduceImages(const std::string &browser)
926{
927 RWebDisplayArgs args(browser);
928
929 return CheckIfCanProduceImages(args);
930}
931
932///////////////////////////////////////////////////////////////////////////////////////////////////
933/// Detect image format
934/// There is special handling of ".screenshot.pdf" and ".screenshot.png" extensions
935/// Creation of such files relies on headless browser functionality and fully supported only by Chrome browser
936
937std::string RWebDisplayHandle::GetImageFormat(const std::string &fname)
938{
939 std::string _fname = fname;
940 std::transform(_fname.begin(), _fname.end(), _fname.begin(), ::tolower);
941 auto EndsWith = [&_fname](const std::string &suffix) {
942 return (_fname.length() > suffix.length()) ? (0 == _fname.compare(_fname.length() - suffix.length(), suffix.length(), suffix)) : false;
943 };
944
945 if (EndsWith(".screenshot.pdf"))
946 return "s.pdf"s;
947 if (EndsWith(".pdf"))
948 return "pdf"s;
949 if (EndsWith(".json"))
950 return "json"s;
951 if (EndsWith(".svg"))
952 return "svg"s;
953 if (EndsWith(".screenshot.png"))
954 return "s.png"s;
955 if (EndsWith(".png"))
956 return "png"s;
957 if (EndsWith(".jpg") || EndsWith(".jpeg"))
958 return "jpeg"s;
959 if (EndsWith(".webp"))
960 return "webp"s;
961
962 return ""s;
963}
964
965
966///////////////////////////////////////////////////////////////////////////////////////////////////
967/// Produce image file using JSON data as source
968/// Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox
969
970bool RWebDisplayHandle::ProduceImage(const std::string &fname, const std::string &json, int width, int height, const char *batch_file)
971{
972 return ProduceImages(fname, {json}, {width}, {height}, batch_file);
973}
974
975
976///////////////////////////////////////////////////////////////////////////////////////////////////
977/// Produce vector of file names for specified file pattern
978/// Depending from supported file forma
979
980std::vector<std::string> RWebDisplayHandle::ProduceImagesNames(const std::string &fname, unsigned nfiles)
981{
982 auto fmt = GetImageFormat(fname);
983
984 std::vector<std::string> fnames;
985
986 if ((fmt == "s.pdf") || (fmt == "s.png")) {
987 fnames.emplace_back(fname);
988 } else {
989 std::string farg = fname;
990
991 bool has_quialifier = farg.find("%") != std::string::npos;
992
993 if (!has_quialifier && (nfiles > 1) && (fmt != "pdf")) {
994 farg.insert(farg.rfind("."), "%d");
995 has_quialifier = true;
996 }
997
998 for (unsigned n = 0; n < nfiles; n++) {
999 if(has_quialifier) {
1000 auto expand_name = TString::Format(farg.c_str(), (int) n);
1001 fnames.emplace_back(expand_name.Data());
1002 } else if (n > 0)
1003 fnames.emplace_back(""); // empty name is multiPdf
1004 else
1005 fnames.emplace_back(fname);
1006 }
1007 }
1008
1009 return fnames;
1010}
1011
1012
1013///////////////////////////////////////////////////////////////////////////////////////////////////
1014/// Produce image file(s) using JSON data as source
1015/// Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox
1016
1017bool RWebDisplayHandle::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)
1018{
1019 return ProduceImages(ProduceImagesNames(fname, jsons.size()), jsons, widths, heights, batch_file);
1020}
1021
1022///////////////////////////////////////////////////////////////////////////////////////////////////
1023/// Produce image file(s) using JSON data as source
1024/// Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox
1025
1026bool RWebDisplayHandle::ProduceImages(const std::vector<std::string> &fnames, const std::vector<std::string> &jsons, const std::vector<int> &widths, const std::vector<int> &heights, const char *batch_file)
1027{
1028 if (fnames.empty() || jsons.empty())
1029 return false;
1030
1031 std::vector<std::string> fmts;
1032 for (auto& fname : fnames)
1033 fmts.emplace_back(GetImageFormat(fname));
1034
1035 bool is_any_image = false;
1036
1037 for (unsigned n = 0; (n < fmts.size()) && (n < jsons.size()); n++) {
1038 if (fmts[n] == "json") {
1039 std::ofstream ofs(fnames[n]);
1040 ofs << jsons[n];
1041 fmts[n].clear();
1042 } else if (!fmts[n].empty())
1043 is_any_image = true;
1044 }
1045
1046 if (!is_any_image)
1047 return true;
1048
1049 std::string fdebug;
1050 if (fnames.size() == 1)
1051 fdebug = fnames[0];
1052 else
1054
1055 const char *jsrootsys = gSystem->Getenv("JSROOTSYS");
1056 TString jsrootsysdflt;
1057 if (!jsrootsys) {
1058 jsrootsysdflt = TROOT::GetDataDir() + "/js";
1059 if (gSystem->ExpandPathName(jsrootsysdflt)) {
1060 R__LOG_ERROR(WebGUILog()) << "Fail to locate JSROOT " << jsrootsysdflt;
1061 return false;
1062 }
1063 jsrootsys = jsrootsysdflt.Data();
1064 }
1065
1066 RWebDisplayArgs args; // set default browser kind, only Chrome/Firefox/Edge or CEF/Qt5/Qt6 can be used here
1067 if (!CheckIfCanProduceImages(args)) {
1068 R__LOG_ERROR(WebGUILog()) << "Fail to detect supported browsers for image production";
1069 return false;
1070 }
1071
1072 auto isChromeBased = (args.GetBrowserKind() == RWebDisplayArgs::kChrome) || (args.GetBrowserKind() == RWebDisplayArgs::kEdge),
1073 isFirefox = args.GetBrowserKind() == RWebDisplayArgs::kFirefox;
1074
1075 std::vector<std::string> draw_kinds;
1076 bool use_browser_draw = false;
1077 TString jsonkind;
1078
1079 if (fmts[0] == "s.png") {
1080 if (!isChromeBased && !isFirefox) {
1081 R__LOG_ERROR(WebGUILog()) << "Direct png image creation supported only by Chrome and Firefox browsers";
1082 return false;
1083 }
1084 use_browser_draw = true;
1085 jsonkind = "1111"; // special mark in canv_batch.htm
1086 } else if (fmts[0] == "s.pdf") {
1087 if (!isChromeBased) {
1088 R__LOG_ERROR(WebGUILog()) << "Direct creation of PDF files supported only by Chrome-based browser";
1089 return false;
1090 }
1091 use_browser_draw = true;
1092 jsonkind = "2222"; // special mark in canv_batch.htm
1093 } else {
1094 draw_kinds = fmts;
1095 jsonkind = TBufferJSON::ToJSON(&draw_kinds, TBufferJSON::kNoSpaces);
1096 }
1097
1098 if (!batch_file || !*batch_file)
1099 batch_file = "/js/files/canv_batch.htm";
1100
1101 TString origin = TROOT::GetDataDir() + batch_file;
1102 if (gSystem->ExpandPathName(origin)) {
1103 R__LOG_ERROR(WebGUILog()) << "Fail to find " << origin;
1104 return false;
1105 }
1106
1107 auto filecont = THttpServer::ReadFileContent(origin.Data());
1108 if (filecont.empty()) {
1109 R__LOG_ERROR(WebGUILog()) << "Fail to read content of " << origin;
1110 return false;
1111 }
1112
1113 int max_width = 0, max_height = 0, page_margin = 10;
1114 for (auto &w : widths)
1115 if (w > max_width)
1116 max_width = w;
1117 for (auto &h : heights)
1118 if (h > max_height)
1119 max_height = h;
1120
1121 auto jsonw = TBufferJSON::ToJSON(&widths, TBufferJSON::kNoSpaces);
1122 auto jsonh = TBufferJSON::ToJSON(&heights, TBufferJSON::kNoSpaces);
1123
1124 std::string mains;
1125 for (auto &json : jsons) {
1126 mains.append(mains.empty() ? "[" : ", ");
1127 mains.append(json);
1128 }
1129 mains.append("]");
1130
1131 if (strstr(jsrootsys, "http://") || strstr(jsrootsys, "https://") || strstr(jsrootsys, "file://"))
1132 filecont = std::regex_replace(filecont, std::regex("\\$jsrootsys"), jsrootsys);
1133 else {
1134 static std::string jsroot_include = "<script id=\"jsroot\" src=\"$jsrootsys/build/jsroot.js\"></script>";
1135 auto p = filecont.find(jsroot_include);
1136 if (p != std::string::npos) {
1137 auto jsroot_build = THttpServer::ReadFileContent(std::string(jsrootsys) + "/build/jsroot.js");
1138 if (!jsroot_build.empty()) {
1139 // insert actual jsroot file location
1140 jsroot_build = std::regex_replace(jsroot_build, std::regex("'\\$jsrootsys'"), std::string("'file://") + jsrootsys + "/'");
1141 filecont.erase(p, jsroot_include.length());
1142 filecont.insert(p, "<script id=\"jsroot\">" + jsroot_build + "</script>");
1143 }
1144 }
1145
1146 filecont = std::regex_replace(filecont, std::regex("\\$jsrootsys"), "file://"s + jsrootsys);
1147 }
1148
1149 filecont = std::regex_replace(filecont, std::regex("\\$page_margin"), std::to_string(page_margin) + "px");
1150 filecont = std::regex_replace(filecont, std::regex("\\$page_width"), std::to_string(max_width + 2*page_margin) + "px");
1151 filecont = std::regex_replace(filecont, std::regex("\\$page_height"), std::to_string(max_height + 2*page_margin) + "px");
1152
1153 filecont = std::regex_replace(filecont, std::regex("\\$draw_kind"), jsonkind.Data());
1154 filecont = std::regex_replace(filecont, std::regex("\\$draw_widths"), jsonw.Data());
1155 filecont = std::regex_replace(filecont, std::regex("\\$draw_heights"), jsonh.Data());
1156 filecont = std::regex_replace(filecont, std::regex("\\$draw_objects"), mains);
1157
1158 TString dump_name;
1159 if (!use_browser_draw && (isChromeBased || isFirefox)) {
1160 dump_name = "canvasdump";
1161 FILE *df = gSystem->TempFileName(dump_name);
1162 if (!df) {
1163 R__LOG_ERROR(WebGUILog()) << "Fail to create temporary file for dump-dom";
1164 return false;
1165 }
1166 fputs("placeholder", df);
1167 fclose(df);
1168 }
1169
1170 // When true, place HTML file into home directory
1171 // Some Chrome installation do not allow run html code from files, created in /tmp directory
1172 static bool chrome_tmp_workaround = false;
1173
1174 TString tmp_name, html_name;
1175
1176try_again:
1177
1179 args.SetUrl(""s);
1180 args.SetPageContent(filecont);
1181
1182 tmp_name.Clear();
1183 html_name.Clear();
1184
1185 R__LOG_DEBUG(0, WebGUILog()) << "Using file content_len " << filecont.length() << " to produce batch images ";
1186
1187 } else {
1188 tmp_name = "canvasbody";
1189 FILE *hf = gSystem->TempFileName(tmp_name);
1190 if (!hf) {
1191 R__LOG_ERROR(WebGUILog()) << "Fail to create temporary file for batch job";
1192 return false;
1193 }
1194 fputs(filecont.c_str(), hf);
1195 fclose(hf);
1196
1197 html_name = tmp_name + ".html";
1198
1199 if (chrome_tmp_workaround) {
1200 std::string homedir = gSystem->GetHomeDirectory();
1201 auto pos = html_name.Last('/');
1202 if (pos == kNPOS)
1203 html_name = TString::Format("/random%d.html", gRandom->Integer(1000000));
1204 else
1205 html_name.Remove(0, pos);
1206 html_name = homedir + html_name.Data();
1207 gSystem->Unlink(html_name.Data());
1208 gSystem->Unlink(tmp_name.Data());
1209
1210 std::ofstream ofs(html_name.Data(), std::ofstream::out);
1211 ofs << filecont;
1212 } else {
1213 if (gSystem->Rename(tmp_name.Data(), html_name.Data()) != 0) {
1214 R__LOG_ERROR(WebGUILog()) << "Fail to rename temp file " << tmp_name << " into " << html_name;
1215 gSystem->Unlink(tmp_name.Data());
1216 return false;
1217 }
1218 }
1219
1220 args.SetUrl("file://"s + gSystem->UnixPathName(html_name.Data()));
1221 args.SetPageContent(""s);
1222
1223 R__LOG_DEBUG(0, WebGUILog()) << "Using " << html_name << " content_len " << filecont.length() << " to produce batch images " << fdebug;
1224 }
1225
1226 TString wait_file_name, tgtfilename;
1227
1228 args.SetStandalone(true);
1229 args.SetHeadless(true);
1230 args.SetBatchMode(true);
1231 args.SetSize(widths[0], heights[0]);
1232
1233 if (use_browser_draw) {
1234
1235 tgtfilename = fnames[0].c_str();
1236 if (!gSystem->IsAbsoluteFileName(tgtfilename.Data()))
1238
1239 wait_file_name = tgtfilename;
1240
1241 if (fmts[0] == "s.pdf")
1242 args.SetExtraArgs("--print-to-pdf-no-header --print-to-pdf="s + gSystem->UnixPathName(tgtfilename.Data()));
1243 else if (isFirefox) {
1244 args.SetExtraArgs("--screenshot"); // firefox does not let specify output image file
1245 wait_file_name = "screenshot.png";
1246 } else
1247 args.SetExtraArgs("--screenshot="s + gSystem->UnixPathName(tgtfilename.Data()));
1248
1249 // remove target image file - we use it as detection when chrome is ready
1250 gSystem->Unlink(tgtfilename.Data());
1251
1252 } else if (isFirefox) {
1253 // firefox will use window.dump to output produced result
1254 args.SetRedirectOutput(dump_name.Data());
1255 gSystem->Unlink(dump_name.Data());
1256 } else if (isChromeBased) {
1257 // chrome should have --dump-dom args configures
1258 args.SetRedirectOutput(dump_name.Data());
1259 gSystem->Unlink(dump_name.Data());
1260 }
1261
1262 auto handle = RWebDisplayHandle::Display(args);
1263
1264 if (!handle) {
1265 R__LOG_DEBUG(0, WebGUILog()) << "Cannot start " << args.GetBrowserName() << " to produce image " << fdebug;
1266 return false;
1267 }
1268
1269 // delete temporary HTML file
1270 if (html_name.Length() > 0) {
1271 if (gEnv->GetValue("WebGui.PreserveBatchFiles", -1) > 0)
1272 ::Info("ProduceImages", "Preserve batch file %s", html_name.Data());
1273 else
1274 gSystem->Unlink(html_name.Data());
1275 }
1276
1277 if (!wait_file_name.IsNull() && gSystem->AccessPathName(wait_file_name.Data())) {
1278 R__LOG_ERROR(WebGUILog()) << "Fail to produce image " << fdebug;
1279 return false;
1280 }
1281
1282 if (use_browser_draw) {
1283 if (fmts[0] == "s.pdf")
1284 ::Info("ProduceImages", "PDF file %s with %d pages has been created", fnames[0].c_str(), (int) jsons.size());
1285 else {
1286 if (isFirefox)
1287 gSystem->Rename("screenshot.png", fnames[0].c_str());
1288 ::Info("ProduceImages", "PNG file %s with %d pages has been created", fnames[0].c_str(), (int) jsons.size());
1289 }
1290 } else {
1291 auto dumpcont = handle->GetContent();
1292
1293 if ((dumpcont.length() > 20) && (dumpcont.length() < 60) && !chrome_tmp_workaround && isChromeBased) {
1294 // chrome creates dummy html file with mostly no content
1295 // problem running chrome from /tmp directory, lets try work from home directory
1296
1297 printf("Handle chrome workaround\n");
1298 chrome_tmp_workaround = true;
1299 goto try_again;
1300 }
1301
1302 if (dumpcont.length() < 100) {
1303 R__LOG_ERROR(WebGUILog()) << "Fail to dump HTML code into " << (dump_name.IsNull() ? "CEF" : dump_name.Data());
1304 return false;
1305 }
1306
1307 std::string::size_type p = 0;
1308
1309 for (unsigned n = 0; n < fmts.size(); n++) {
1310 if (fmts[n].empty())
1311 continue;
1312 if (fmts[n] == "svg") {
1313 auto p1 = dumpcont.find("<svg", p);
1314 auto p2 = dumpcont.find("</svg></div>", p1 + 4);
1315 p = p2 + 6;
1316 std::ofstream ofs(fnames[n]);
1317 if ((p1 != std::string::npos) && (p2 != std::string::npos) && (p1 < p2)) {
1318 ofs << dumpcont.substr(p1, p2-p1+6);
1319 ::Info("ProduceImages", "SVG file %s size %d bytes has been created", fnames[n].c_str(), (int) (p2-p1+6));
1320 } else {
1321 R__LOG_ERROR(WebGUILog()) << "Fail to extract SVG from HTML dump " << dump_name;
1322 ofs << "Failure!!!\n" << dumpcont;
1323 return false;
1324 }
1325 } else {
1326 auto p1 = dumpcont.find(";base64,", p);
1327 auto p2 = dumpcont.find("></div>", p1 + 4);
1328 p = p2 + 5;
1329
1330 if ((p1 != std::string::npos) && (p2 != std::string::npos) && (p1 < p2)) {
1331 auto base64 = dumpcont.substr(p1+8, p2-p1-9);
1332 auto binary = TBase64::Decode(base64.c_str());
1333
1334 std::ofstream ofs(fnames[n], std::ios::binary);
1335 ofs.write(binary.Data(), binary.Length());
1336
1337 ::Info("ProduceImages", "Image file %s size %d bytes has been created", fnames[n].c_str(), (int) binary.Length());
1338 } else {
1339 R__LOG_ERROR(WebGUILog()) << "Fail to extract image from dump HTML code " << dump_name;
1340
1341 return false;
1342 }
1343 }
1344 }
1345 }
1346
1347 R__LOG_DEBUG(0, WebGUILog()) << "Create " << (fnames.size() > 1 ? "files " : "file ") << fdebug;
1348
1349 return true;
1350}
1351
nlohmann::json json
#define R__LOG_ERROR(...)
Definition RLogger.hxx:362
#define R__LOG_DEBUG(DEBUGLEVEL,...)
Definition RLogger.hxx:365
#define f(i)
Definition RSha256.hxx:104
#define c(i)
Definition RSha256.hxx:101
#define h(i)
Definition RSha256.hxx:106
constexpr Ssiz_t kNPOS
Definition RtypesCore.h:117
R__EXTERN TEnv * gEnv
Definition TEnv.h:170
void Info(const char *location, const char *msgfmt,...)
Use this function for informational messages.
Definition TError.cxx:218
winID h TVirtualViewer3D TVirtualGLPainter p
Option_t Option_t width
Option_t Option_t style
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t height
char name[80]
Definition TGX11.cxx:110
R__EXTERN TRandom * gRandom
Definition TRandom.h:62
@ kExecutePermission
Definition TSystem.h:43
R__EXTERN TSystem * gSystem
Definition TSystem.h:561
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
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.
@ kSafari
Safari browser.
@ 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 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.
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.
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.
Definition TBase64.cxx:131
static TString ToJSON(const T *obj, Int_t compact=0, const char *member_name=nullptr)
Definition TBufferJSON.h:75
@ kNoSpaces
no new lines plus remove all spaces around "," and ":" symbols
Definition TBufferJSON.h:39
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
Definition TEnv.cxx:491
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".
Definition TObject.cxx:542
static const TString & GetEtcDir()
Get the sysconfig directory in the installation. Static utility function.
Definition TROOT.cxx:3056
static const TString & GetDataDir()
Get the data directory in the installation. Static utility function.
Definition TROOT.cxx:3066
virtual void SetSeed(ULong_t seed=0)
Set the random generator seed.
Definition TRandom.cxx:615
virtual UInt_t Integer(UInt_t imax)
Returns a random integer uniformly distributed on the interval [ 0, imax-1 ].
Definition TRandom.cxx:361
Basic string class.
Definition TString.h:139
Ssiz_t Length() const
Definition TString.h:417
void Clear()
Clear string without changing its capacity.
Definition TString.cxx:1235
const char * Data() const
Definition TString.h:376
Ssiz_t Last(char c) const
Find last occurrence of a character c.
Definition TString.cxx:931
TObjArray * Tokenize(const TString &delim) const
This function is used to isolate sequential tokens in a TString.
Definition TString.cxx:2264
Bool_t IsNull() const
Definition TString.h:414
TString & Remove(Ssiz_t pos)
Definition TString.h:685
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:2378
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.
Definition TSystem.cxx:1499
virtual Bool_t ExpandPathName(TString &path)
Expand a pathname getting rid of special shell characters like ~.
Definition TSystem.cxx:1274
virtual const char * Getenv(const char *env)
Get environment variable.
Definition TSystem.cxx:1665
virtual int mkdir(const char *name, Bool_t recursive=kFALSE)
Make a file system directory.
Definition TSystem.cxx:906
virtual Int_t Exec(const char *shellcmd)
Execute a command.
Definition TSystem.cxx:653
virtual int Load(const char *module, const char *entry="", Bool_t system=kFALSE)
Load a shared library.
Definition TSystem.cxx:1857
virtual const char * PrependPathName(const char *dir, TString &name)
Concatenate a directory and a file name.
Definition TSystem.cxx:1081
virtual Bool_t AccessPathName(const char *path, EAccessMode mode=kFileExists)
Returns FALSE if one can access a file using the specified access mode.
Definition TSystem.cxx:1296
virtual std::string GetHomeDirectory(const char *userName=nullptr) const
Return the user's home directory.
Definition TSystem.cxx:895
virtual const char * UnixPathName(const char *unixpathname)
Convert from a local pathname to a Unix pathname.
Definition TSystem.cxx:1063
virtual int Rename(const char *from, const char *to)
Rename a file.
Definition TSystem.cxx:1350
virtual TString GetFromPipe(const char *command)
Execute command and return output in TString.
Definition TSystem.cxx:680
virtual Bool_t IsAbsoluteFileName(const char *dir)
Return true if dir is an absolute pathname.
Definition TSystem.cxx:951
virtual const char * WorkingDirectory()
Return working directory.
Definition TSystem.cxx:871
virtual int Unlink(const char *name)
Unlink, i.e.
Definition TSystem.cxx:1381
virtual const char * TempDirectory() const
Return a user configured or systemwide directory to create temporary files in.
Definition TSystem.cxx:1482
const Int_t n
Definition legend1.C:16
TH1F * h1
Definition legend1.C:5
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.
TCanvas * slash()
Definition slash.C:1
TMarker m
Definition textangle.C:8