22#include "RConfigure.h"
178 ::Warning(
"THttpServer::THttpServer",
"problems resolving '%s', set JSROOTSYS to proper JavaScript ROOT location",
206 ::Warning(
"THttpServer::THttpServer",
"Fail to load TRootSnifferFull class, use basic functionality");
212 sniff->CreateOwnTopFolder();
226 const char *opt =
lst->At(
n)->GetName();
227 if ((
strcmp(opt,
"readonly") == 0) || (
strcmp(opt,
"ro") == 0)) {
229 }
else if ((
strcmp(opt,
"readwrite") == 0) || (
strcmp(opt,
"rw") == 0)) {
231 }
else if (
strcmp(opt,
"global") == 0) {
233 }
else if (
strcmp(opt,
"noglobal") == 0) {
235 }
else if (
strncmp(opt,
"cors=", 5) == 0) {
237 }
else if (
strcmp(opt,
"cors") == 0) {
366 if (!prefix || (*prefix == 0))
389 fJSROOT = location ? location :
"";
470 }
else if (
clname ==
"socket") {
476 }
else if (
clname ==
"https") {
478 }
else if (
clname ==
"fastcgi") {
493 eng->SetServer(
this);
495 if (!
eng->Create(arg)) {
530 Error(
"SetTimer",
"Server runs already in special thread, therefore no any timer can be created");
556 std::thread
thrd([
this] {
566 std::this_thread::sleep_for(std::chrono::milliseconds(1));
646 if (!uri || (*uri == 0))
655 fname.Remove(0, pos + (
entry.first.length() - 1));
658 res =
entry.second.c_str();
659 if ((
fname[0] ==
'/') && (res[res.
Length() - 1] ==
'/'))
691 std::unique_lock<std::mutex>
lk(
fMutex);
720 arg->NotifyCondition();
725 std::unique_lock<std::mutex>
lk(
fMutex);
746 Warning(
"ProcessRequests",
"Changing main thread to %ld", (
long)
id);
766 std::unique_lock<std::mutex>
lk(
fMutex, std::defer_lock);
770 std::shared_ptr<THttpCallArg> arg;
773 if (!
fArgs.empty()) {
782 if (arg->fFileName ==
"root_batch_holder.js") {
787 auto prev =
fSniffer->SetCurrentCallArg(arg.get());
797 arg->NotifyCondition();
835 if (!
wsptr || !
wsptr->ProcessBatchHolder(arg)) {
837 arg->NotifyCondition();
847 std::string
arr =
"[";
852 if (
arr.length() > 1)
855 arr.append(
TString::Format(
"{ name: \"%s\", title: \"%s\" }", ws->GetName(), ws->GetTitle()).Data());
863 std::string arg =
"\"$$$wslist$$$\"";
865 auto pos = res.find(arg);
866 if (pos != std::string::npos)
867 res.replace(pos, arg.length(),
arr);
881 const std::string
place_holder =
"<!--jsroot_importmap-->";
889 if (arg->fPathName.Length() > 0)
891 for (
Int_t n = 1;
n < arg->fPathName.Length()-1; ++
n)
892 if (arg->fPathName[
n] ==
'/') {
893 if (arg->fPathName[
n-1] !=
'/') {
907 std::string
search =
"from './jsrootsys/";
908 std::string replace =
"from './" +
version +
"/jsrootsys/";
909 arg->ReplaceAllinContent(
search, replace);
911 search =
"from './rootui5sys/";
912 replace =
"from './" +
version +
"/rootui5sys/";
913 arg->ReplaceAllinContent(
search, replace);
915 search =
"jsrootsys/scripts/JSRoot.core.";
916 replace =
version +
"/jsrootsys/scripts/JSRoot.core.";
917 arg->ReplaceAllinContent(
search, replace,
true);
918 arg->AddNoCacheHeader();
926 if (
repl.back() !=
'/')
932 repl.append(
"jsrootsys/");
937 arg->ReplaceAllinContent(
"=\"jsrootsys/",
repl);
938 arg->ReplaceAllinContent(
"from './jsrootsys/",
TString::Format(
"from '%s",
repl.substr(2).c_str()).Data());
963 static std::map<std::string, std::string>
modules = {
964 {
"jsroot",
"main.mjs"}, {
"jsroot/core",
"core.mjs"},
965 {
"jsroot/io",
"io.mjs"}, {
"jsroot/tree",
"tree.mjs"},
966 {
"jsroot/draw",
"draw.mjs"}, {
"jsroot/gui",
"gui.mjs"},
967 {
"jsroot/d3",
"d3.mjs"}, {
"jsroot/three",
"three.mjs"}, {
"jsroot/three_addons",
"three_addons.mjs"},
968 {
"jsroot/geom",
"geom/TGeoPainter.mjs"}, {
"jsroot/hpainter",
"gui/HierarchyPainter.mjs"},
969 {
"jsroot/webwindow",
"webwindow.mjs"}
988 if (
entry.first !=
"jsrootsys/")
1014 if ((arg->fFileName ==
"root.websocket") || (arg->fFileName ==
"root.longpoll")) {
1019 if (arg->fFileName.IsNull() || (arg->fFileName ==
"index.htm") || (arg->fFileName ==
"default.htm")) {
1023 if (arg->fFileName ==
"default.htm") {
1031 auto handler =
wsptr.get();
1038 arg->fContent = handler->GetDefaultPageContent().Data();
1040 if (arg->fContent.find(
"file:") == 0) {
1041 const char *
fname = arg->fContent.c_str() + 5;
1047 version = handler->GetCodeVersion();
1049 handler->VerifyDefaultPageContent(arg);
1053 if (arg->fContent.empty() && arg->fFileName.IsNull() && arg->fPathName.IsNull() &&
IsWSOnly()) {
1058 arg->SetContent(
"refused");
1062 if (arg->fContent.empty() && !
IsWSOnly()) {
1070 if (arg->fContent.empty()) {
1073 }
else if (!arg->Is404()) {
1077 const char *
hjsontag =
"\"$$$h.json$$$\"";
1080 if (arg->fContent.find(
hjsontag) != std::string::npos) {
1084 if (arg->fTopName.Length() > 0)
1085 topname = arg->fTopName.Data();
1090 arg->AddNoCacheHeader();
1092 if (arg->fQuery.Index(
"nozip") ==
kNPOS)
1095 arg->SetContentType(
"text/html");
1100 if ((arg->fFileName ==
"draw.htm") && !
IsWSOnly()) {
1108 const char *
hjsontag =
"\"$$$h.json$$$\"";
1114 if ((arg->fQuery.Index(
"no_h_json") ==
kNPOS) && (arg->fQuery.Index(
"webcanvas") ==
kNPOS) &&
1115 (arg->fContent.find(
hjsontag) != std::string::npos)) {
1119 if (arg->fTopName.Length() > 0)
1120 topname = arg->fTopName.Data();
1126 if ((arg->fQuery.Index(
"no_root_json") ==
kNPOS) && (arg->fQuery.Index(
"webcanvas") ==
kNPOS) &&
1127 (arg->fContent.find(
rootjsontag) != std::string::npos)) {
1129 if (
fSniffer->Produce(arg->fPathName.Data(),
"root.json",
"compact=23", str))
1132 arg->AddNoCacheHeader();
1133 if (arg->fQuery.Index(
"nozip") ==
kNPOS)
1135 arg->SetContentType(
"text/html");
1140 if ((arg->fFileName ==
"favicon.ico") && arg->fPathName.IsNull()) {
1141 arg->SetFile(
fJSROOTSYS +
"/img/RootIcon.ico");
1152 if (!arg->fPathName.IsNull() && !arg->fFileName.IsNull()) {
1154 auto pos =
wsname.First(
'/');
1158 wsname = arg->fPathName(0, pos);
1159 fname = arg->fPathName(pos + 1, arg->fPathName.Length() - pos);
1163 fname.Append(arg->fFileName);
1169 if (ws && ws->CanServeFiles()) {
1170 TString fdir = ws->GetDefaultPageContent();
1172 if (fdir.
Index(
"file:") == 0) {
1197 if (arg->fContent.empty())
1205 res.
Form(
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
1215 if (arg->fTopName.Length() > 0)
1216 topname = arg->fTopName.Data();
1224 arg->SetContent(std::string(res.
Data()));
1231 if (arg->fTopName.Length() > 0)
1232 topname = arg->fTopName.Data();
1234 arg->SetContent(std::string(res.
Data()));
1236 }
else if (
fSniffer->Produce(arg->fPathName.Data(),
filename.Data(), arg->fQuery.Data(), arg->fContent)) {
1253 const char *
parname =
fSniffer->IsStreamerInfoItem(arg->fPathName.Data()) ?
"BVersion" :
"MVersion";
1258 arg->AddNoCacheHeader();
1262 arg->AddHeader(
"Access-Control-Allow-Origin",
GetCors());
1284 return fSniffer->UnregisterObject(obj);
1337 auto handler =
wsptr.get();
1342 if (
external_thrd && (!handler || !handler->AllowMTProcess())) {
1347 std::unique_lock<std::mutex>
lk(
fMutex);
1351 arg->fCond.wait(
lk);
1363 if (arg->fFileName ==
"root.websocket") {
1365 process = handler->HandleWS(arg);
1366 }
else if (arg->fFileName ==
"root.longpoll") {
1368 if (arg->fQuery.BeginsWith(
"raw_connect") || arg->fQuery.BeginsWith(
"txt_connect")) {
1371 arg->SetMethod(
"WS_CONNECT");
1373 bool israw = arg->fQuery.BeginsWith(
"raw_connect");
1378 if (handler->HandleWS(arg)) {
1379 arg->SetMethod(
"WS_READY");
1381 if (handler->HandleWS(arg))
1382 arg->SetTextContent(std::string(
israw ?
"txt:" :
"") + std::to_string(arg->GetWSId()));
1384 arg->TakeWSEngine();
1387 process = arg->IsText();
1390 url.SetOptions(arg->fQuery);
1392 const char *connid =
url.GetValueFromOptions(
"connection");
1394 arg->SetWSId(std::stoul(connid));
1395 if (
url.HasOption(
"close")) {
1396 arg->SetMethod(
"WS_CLOSE");
1397 arg->SetTextContent(
"OK");
1399 arg->SetMethod(
"WS_DATA");
1402 process = handler->HandleWS(arg);
1488 return fSniffer->CreateItem(fullname, title);
1512 static const struct {
1517 {
".json", 5,
"application/json"},
1518 {
".bin", 4,
"application/x-binary"},
1519 {
".gif", 4,
"image/gif"},
1520 {
".jpg", 4,
"image/jpeg"},
1521 {
".png", 4,
"image/png"},
1522 {
".html", 5,
"text/html"},
1523 {
".htm", 4,
"text/html"},
1524 {
".shtm", 5,
"text/html"},
1525 {
".shtml", 6,
"text/html"},
1526 {
".css", 4,
"text/css"},
1527 {
".js", 3,
"application/x-javascript"},
1528 {
".mjs", 4,
"text/javascript"},
1529 {
".ico", 4,
"image/x-icon"},
1530 {
".jpeg", 5,
"image/jpeg"},
1531 {
".svg", 4,
"image/svg+xml"},
1532 {
".txt", 4,
"text/plain"},
1533 {
".torrent", 8,
"application/x-bittorrent"},
1534 {
".wav", 4,
"audio/x-wav"},
1535 {
".mp3", 4,
"audio/x-mp3"},
1536 {
".mid", 4,
"audio/mid"},
1537 {
".m3u", 4,
"audio/x-mpegurl"},
1538 {
".ogg", 4,
"application/ogg"},
1539 {
".ram", 4,
"audio/x-pn-realaudio"},
1540 {
".xslt", 5,
"application/xml"},
1541 {
".xsl", 4,
"application/xml"},
1542 {
".ra", 3,
"audio/x-pn-realaudio"},
1543 {
".doc", 4,
"application/msword"},
1544 {
".exe", 4,
"application/octet-stream"},
1545 {
".zip", 4,
"application/x-zip-compressed"},
1546 {
".xls", 4,
"application/excel"},
1547 {
".tgz", 4,
"application/x-tar-gz"},
1548 {
".tar", 4,
"application/x-tar"},
1549 {
".gz", 3,
"application/x-gunzip"},
1550 {
".arj", 4,
"application/x-arj-compressed"},
1551 {
".rar", 4,
"application/x-arj-compressed"},
1552 {
".rtf", 4,
"application/rtf"},
1553 {
".pdf", 4,
"application/pdf"},
1554 {
".swf", 4,
"application/x-shockwave-flash"},
1555 {
".mpg", 4,
"video/mpeg"},
1556 {
".webm", 5,
"video/webm"},
1557 {
".mpeg", 5,
"video/mpeg"},
1558 {
".mov", 4,
"video/quicktime"},
1559 {
".mp4", 4,
"video/mp4"},
1560 {
".m4v", 4,
"video/x-m4v"},
1561 {
".asf", 4,
"video/x-ms-asf"},
1562 {
".avi", 4,
"video/x-msvideo"},
1563 {
".bmp", 4,
"image/bmp"},
1564 {
".ttf", 4,
"application/x-font-ttf"},
1565 {
".woff", 5,
"font/woff"},
1566 {
".woff2", 6,
"font/woff2"},
1580 return "text/plain";
1592 std::ifstream
is(
filename, std::ios::in | std::ios::binary);
1598 is.seekg(0,
is.beg);
1616 std::ifstream
is(
filename, std::ios::in | std::ios::binary);
1619 is.seekg(0, std::ios::end);
1620 res.resize(
is.tellg());
1621 is.seekg(0, std::ios::beg);
1622 is.read((
char *)res.data(), res.length());
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
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 WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize id
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 TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t UChar_t len
Option_t Option_t TPoint TPoint const char mode
R__EXTERN TSystem * gSystem
static const struct @140 builtin_mime_types[]
const_iterator end() const
THttpEngine implementation, based on civetweb embedded server.
TClass instances represent classes, structs and namespaces in the ROOT type system.
static TClass * GetClass(const char *name, Bool_t load=kTRUE, Bool_t silent=kFALSE)
Static method returning pointer to TClass of the specified class name.
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
THttpEngine implementation, based on fastcgi package.
Contains arguments for single HTTP call.
void Set404()
mark reply as 404 error - page/request not exists or refused
Abstract class for implementing http protocol for THttpServer.
Emulation of websocket with long poll requests.
Online http server for arbitrary ROOT application.
Bool_t IsReadOnly() const
returns read-only mode
Bool_t RegisterCommand(const char *cmdname, const char *method, const char *icon=nullptr)
Register command which can be executed from web interface.
TString fJSROOT
! location of external JSROOT files
virtual void ProcessRequest(std::shared_ptr< THttpCallArg > arg)
Process single http request.
std::shared_ptr< THttpWSHandler > FindWS(const char *name)
Find web-socket handler with given name.
std::unique_ptr< TRootSniffer > fSniffer
! sniffer provides access to ROOT objects hierarchy
void SetTimer(Long_t milliSec=100, Bool_t mode=kTRUE)
Create timer which will invoke ProcessRequests() function periodically.
virtual void ProcessBatchHolder(std::shared_ptr< THttpCallArg > &arg)
Process special http request for root_batch_holder.js script.
std::vector< std::shared_ptr< THttpWSHandler > > fWSHandlers
! list of WS handlers
virtual ~THttpServer()
destructor
void SetTerminate()
set termination flag, no any further requests will be processed
virtual void MissedRequest(THttpCallArg *arg)
Method called when THttpServer cannot process request.
Bool_t fOwnThread
! true when specialized thread allocated for processing requests
void SetSniffer(TRootSniffer *sniff)
Set TRootSniffer to the server.
Bool_t IsFileRequested(const char *uri, TString &res) const
Check if file is requested, thread safe.
void SetReadOnly(Bool_t readonly=kTRUE)
Set read-only mode for the server (default on)
const char * GetItemField(const char *fullname, const char *name)
Get item field from sniffer.
const char * GetCors() const
Returns specified CORS domain.
std::thread fThrd
! own thread
void StopServerThread()
Stop server thread.
Int_t ProcessRequests()
Process submitted requests, must be called from appropriate thread.
Bool_t ExecuteWS(std::shared_ptr< THttpCallArg > &arg, Bool_t external_thrd=kFALSE, Bool_t wait_process=kFALSE)
Execute WS request.
void RegisterWS(std::shared_ptr< THttpWSHandler > ws)
Register WS handler.
Long_t fProcessingThrdId
! id of the thread where events are recently processing
TString fTopName
! name of top folder, default - "ROOT"
void SetDrawPage(const std::string &filename="")
Set drawing HTML page.
Bool_t CreateItem(const char *fullname, const char *title)
Create item in sniffer.
Bool_t ExecuteHttp(std::shared_ptr< THttpCallArg > arg)
Execute HTTP request.
Bool_t Hide(const char *fullname, Bool_t hide=kTRUE)
Hides folder or element from web gui.
Bool_t IsCorsCredentials() const
Returns kTRUE if Access-Control-Allow-Credentials header should be used.
void AddLocation(const char *prefix, const char *path)
Add files location, which could be used in the server.
std::map< std::string, std::string > fLocations
! list of local directories, which could be accessed via server
Bool_t SubmitHttp(std::shared_ptr< THttpCallArg > arg, Bool_t can_run_immediately=kFALSE)
Submit HTTP request.
Long_t fMainThrdId
! id of the thread for processing requests
TString fJSROOTSYS
! location of local JSROOT files
std::unique_ptr< THttpTimer > fTimer
! timer used to access main thread
Bool_t fWSOnly
! when true, handle only websockets / longpoll engine
Bool_t Register(const char *subfolder, TObject *obj)
Register object in subfolder.
TList fEngines
! engines which runs http server
void SetCors(const std::string &domain="*")
Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-C...
Bool_t IsCors() const
Returns kTRUE if CORS was configured.
const char * GetCorsCredentials() const
Returns specified CORS credentials value - if any.
std::queue< std::shared_ptr< THttpCallArg > > fArgs
! submitted arguments
void SetDefaultPage(const std::string &filename="")
Set default HTML page.
THttpServer(const THttpServer &)=delete
static char * ReadFileContent(const char *filename, Int_t &len)
Reads content of file from the disk.
void CreateServerThread()
Creates special thread to process all requests, directed to http server.
std::string fDrawPageCont
! content of draw html page
Bool_t Unregister(TObject *obj)
Unregister object.
void SetWSOnly(Bool_t on=kTRUE)
Set websocket-only mode.
std::string BuildWSEntryPage()
Create summary page with active WS handlers.
Bool_t IsWSOnly() const
returns true if only websockets are handled by the server
std::mutex fWSMutex
! mutex to protect WS handler lists
Bool_t CreateEngine(const char *engine)
Factory method to create different http engines.
Bool_t SetIcon(const char *fullname, const char *iconname)
Set name of icon, used in browser together with the item.
std::string fDrawPage
! file name for drawing of single element
std::string fDefaultPageCont
! content of default html page
static Bool_t VerifyFilePath(const char *fname)
Checked that filename does not contains relative path below current directory.
Bool_t IsAllowPostObject() const
Returns true if server accept object content in POST reequests.
Bool_t SetItemField(const char *fullname, const char *name, const char *value)
Set item field in sniffer.
void SetAllowPostObject(Bool_t allow_post_obj)
Set flag to allow receive and desereilize objects in POST requests.
void SetJSROOT(const char *location)
Set location of JSROOT to use with the server.
std::mutex fMutex
! mutex to protect list with arguments
std::string fDefaultPage
! file name for default page name
void UnregisterWS(std::shared_ptr< THttpWSHandler > ws)
Unregister WS handler.
static const char * GetMimeType(const char *path)
Guess mime type base on file extension.
TRootSniffer * GetSniffer() const
returns pointer on objects sniffer
void ReplaceJSROOTLinks(std::shared_ptr< THttpCallArg > &arg, const std::string &version="")
Replaces all references like "jsrootsys/..." or other pre-configured pathes.
Bool_t fTerminated
! termination flag, disables all requests processing
void Restrict(const char *path, const char *options)
Restrict access to specified object.
void Timeout() override
timeout handler used to process http requests in main ROOT thread
void SetSlow(Bool_t flag)
THttpTimer(Long_t milliSec, Bool_t mode, THttpServer &serv)
!< server processing requests
Class for user-side handling of websocket with THttpServer.
void Add(TObject *obj) override
void Delete(Option_t *option="") override
Remove all objects from the list AND delete all heap based objects.
The TNamed class is the base class for all named ROOT classes.
Mother of all ROOT objects.
virtual void Warning(const char *method, const char *msgfmt,...) const
Issue warning message.
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
static const TString & GetRootSys()
Get the rootsys directory in the installation. Static utility function.
static const TString & GetDataDir()
Get the data directory in the installation. Static utility function.
Storage of hierarchy scan in TRootSniffer in JSON format.
Storage of hierarchy scan in TRootSniffer in XML format.
Sniffer of ROOT objects, data provider for THttpServer.
void SetReadOnly(Bool_t on=kTRUE)
When readonly on (default), sniffer is not allowed to change ROOT structures For instance,...
void SetScanGlobalDir(Bool_t on=kTRUE)
When enabled (default), sniffer scans gROOT for files, canvases, histograms.
const char * Data() const
void Resize(Ssiz_t n)
Resize the string. Truncate or add blanks as necessary.
Ssiz_t Last(char c) const
Find last occurrence of a character c.
TObjArray * Tokenize(const TString &delim) const
This function is used to isolate sequential tokens in a TString.
TString & Remove(Ssiz_t pos)
TString & Append(const char *cs)
static TString Format(const char *fmt,...)
Static method which formats a string using a printf style format descriptor and return a TString.
void Form(const char *fmt,...)
Formats a string using a printf style format descriptor.
Ssiz_t Index(const char *pat, Ssiz_t i=0, ECaseCompare cmp=kExact) const
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.
static Long_t SelfId()
Static method returning the id for the current thread.
Handles synchronous and a-synchronous timer events.
void SetTime(Long_t milliSec)
This class represents a WWW compatible URL.