Logo ROOT  
Reference Guide
TWebFile.h
Go to the documentation of this file.
1// @(#)root/net:$Id$
2// Author: Fons Rademakers 17/01/97
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TWebFile
13#define ROOT_TWebFile
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TWebFile //
19// //
20// A TWebFile is like a normal TFile except that it reads its data //
21// via a standard apache web server. A TWebFile is a read-only file. //
22// //
23//////////////////////////////////////////////////////////////////////////
24
25#include "TFile.h"
26#include "TUrl.h"
27#include "TSystem.h"
28
29class TSocket;
30class TWebSocket;
31
32
33class TWebFile : public TFile {
34
35friend class TWebSocket;
36friend class TWebSystem;
37
38private:
39 TWebFile() : fSocket(nullptr) {}
40
41protected:
42 mutable Long64_t fSize; // file size
43 TSocket *fSocket; // socket for HTTP/1.1 (stays alive between calls)
44 TUrl fProxy; // proxy URL
45 Bool_t fHasModRoot; // true if server has mod_root installed
46 Bool_t fHTTP11; // true if server support HTTP/1.1
47 Bool_t fNoProxy; // don't use proxy
48 TString fMsgReadBuffer; // cache ReadBuffer() msg
49 TString fMsgReadBuffer10; // cache ReadBuffer10() msg
50 TString fMsgGetHead; // cache GetHead() msg
51 TString fBasicUrl; // basic url without authentication and options
52 TUrl fUrlOrg; // save original url in case of temp redirection
53 TString fBasicUrlOrg; // save original url in case of temp redirection
54 void *fFullCache; //! complete content of the file, some http server may return complete content
55 Long64_t fFullCacheSize; //! size of the cached content
56
57 static TUrl fgProxy; // globally set proxy URL
58 static Long64_t fgMaxFullCacheSize; // maximal size of full-cached content, 500 MB by default
59
60 void Init(Bool_t readHeadOnly) override;
61 virtual void CheckProxy();
63 virtual Int_t GetHead();
64 virtual Int_t GetLine(TSocket *s, char *line, Int_t maxsize);
65 virtual Int_t GetHunk(TSocket *s, char *hunk, Int_t maxsize);
66 virtual const char *HttpTerminator(const char *start, const char *peeked, Int_t peeklen);
67 virtual Int_t GetFromWeb(char *buf, Int_t len, const TString &msg);
68 virtual Int_t GetFromWeb10(char *buf, Int_t len, const TString &msg, Int_t nseg = 0, Long64_t *seg_pos = 0, Int_t *seg_len = 0);
69 virtual Int_t GetFromCache(char *buf, Int_t len, Int_t nseg, Long64_t *seg_pos, Int_t *seg_len);
70 virtual Bool_t ReadBuffer10(char *buf, Int_t len);
71 virtual Bool_t ReadBuffers10(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
72 virtual void SetMsgReadBuffer10(const char *redirectLocation = 0, Bool_t tempRedirect = kFALSE);
73 virtual void ProcessHttpHeader(const TString& headerLine);
74
75public:
76 TWebFile(const char *url, Option_t *opt="");
77 TWebFile(TUrl url, Option_t *opt="");
78 virtual ~TWebFile();
79
80 Long64_t GetSize() const override;
81 Bool_t IsOpen() const override;
82 Int_t ReOpen(Option_t *mode) override;
83 Bool_t ReadBuffer(char *buf, Int_t len) override;
84 Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len) override;
85 Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf) override;
86 void Seek(Long64_t offset, ERelativeTo pos = kBeg) override;
87
88 static void SetProxy(const char *url);
89 static const char *GetProxy();
90
92 static void SetMaxFullCacheSize(Long64_t sz);
93
94 ClassDefOverride(TWebFile,2) //A ROOT file that reads via a http server
95};
96
97
98class TWebSystem : public TSystem {
99
100private:
101 void *fDirp; // directory handler
102
103 void *GetDirPtr() const override { return fDirp; }
104
105public:
106 TWebSystem();
107 virtual ~TWebSystem() {}
108
109 Int_t MakeDirectory(const char *name) override;
110 void *OpenDirectory(const char *name) override;
111 void FreeDirectory(void *dirp) override;
112 const char *GetDirEntry(void *dirp) override;
113 Int_t GetPathInfo(const char *path, FileStat_t &buf) override;
114 Bool_t AccessPathName(const char *path, EAccessMode mode) override;
115 Int_t Unlink(const char *path) override;
116
117 ClassDefOverride(TWebSystem,0) // Directory handler for HTTP (TWebFiles)
118};
119
120#endif
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
const Bool_t kFALSE
Definition: RtypesCore.h:101
long long Long64_t
Definition: RtypesCore.h:80
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
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 offset
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
char name[80]
Definition: TGX11.cxx:110
EAccessMode
Definition: TSystem.h:43
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:54
ERelativeTo
Definition: TFile.h:193
@ kBeg
Definition: TFile.h:193
Basic string class.
Definition: TString.h:136
Abstract base class defining a generic interface to the underlying Operating System.
Definition: TSystem.h:266
This class represents a WWW compatible URL.
Definition: TUrl.h:33
virtual Int_t GetLine(TSocket *s, char *line, Int_t maxsize)
Read a line from the socket.
Definition: TWebFile.cxx:1194
virtual ~TWebFile()
Cleanup.
Definition: TWebFile.cxx:197
virtual Int_t GetHead()
Get the HTTP header.
Definition: TWebFile.cxx:1027
virtual Int_t GetFromWeb(char *buf, Int_t len, const TString &msg)
Read request from web server.
Definition: TWebFile.cxx:607
virtual TString BasicAuthentication()
Return basic authentication scheme, to be added to the request.
Definition: TWebFile.cxx:1367
Long64_t fSize
Definition: TWebFile.h:42
virtual void SetMsgReadBuffer10(const char *redirectLocation=0, Bool_t tempRedirect=kFALSE)
Set GET command for use by ReadBuffer(s)10(), handle redirection if needed.
Definition: TWebFile.cxx:266
TSocket * fSocket
Definition: TWebFile.h:43
static const char * GetProxy()
Static method returning the global proxy URL.
Definition: TWebFile.cxx:1402
TString fBasicUrl
Definition: TWebFile.h:51
static void SetProxy(const char *url)
Static method setting global proxy URL.
Definition: TWebFile.cxx:1386
virtual const char * HttpTerminator(const char *start, const char *peeked, Int_t peeklen)
Determine whether [START, PEEKED + PEEKLEN) contains an HTTP new line [\r]\n.
Definition: TWebFile.cxx:1332
Long64_t GetSize() const override
Return maximum file size.
Definition: TWebFile.cxx:992
virtual Int_t GetFromCache(char *buf, Int_t len, Int_t nseg, Long64_t *seg_pos, Int_t *seg_len)
Extract requested segments from the cached content.
Definition: TWebFile.cxx:582
TString fBasicUrlOrg
Definition: TWebFile.h:53
Bool_t IsOpen() const override
A TWebFile that has been correctly constructed is always considered open.
Definition: TWebFile.cxx:378
Bool_t fHTTP11
Definition: TWebFile.h:46
virtual void CheckProxy()
Check if shell var "http_proxy" has been set and should be used.
Definition: TWebFile.cxx:351
virtual Bool_t ReadBuffers10(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf)
Read specified byte ranges from remote file via HTTP 1.0 daemon (without mod-root installed).
Definition: TWebFile.cxx:548
Bool_t ReadBuffer(char *buf, Int_t len) override
Read specified byte range from remote file via HTTP daemon.
Definition: TWebFile.cxx:411
Long64_t fFullCacheSize
complete content of the file, some http server may return complete content
Definition: TWebFile.h:55
Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf) override
Read specified byte ranges from remote file via HTTP daemon.
Definition: TWebFile.cxx:499
TUrl fProxy
Definition: TWebFile.h:44
TString fMsgGetHead
Definition: TWebFile.h:50
void Seek(Long64_t offset, ERelativeTo pos=kBeg) override
Set position from where to start reading.
Definition: TWebFile.cxx:971
TString fMsgReadBuffer
Definition: TWebFile.h:48
virtual Bool_t ReadBuffer10(char *buf, Int_t len)
Read specified byte range from remote file via HTTP 1.0 daemon (without mod-root installed).
Definition: TWebFile.cxx:460
void Init(Bool_t readHeadOnly) override
Initialize a TWebFile object.
Definition: TWebFile.cxx:210
TWebFile()
Definition: TWebFile.h:39
static TUrl fgProxy
size of the cached content
Definition: TWebFile.h:57
void * fFullCache
Definition: TWebFile.h:54
static void SetMaxFullCacheSize(Long64_t sz)
Static method, set maxmimal size of full cache,.
Definition: TWebFile.cxx:1431
TString fMsgReadBuffer10
Definition: TWebFile.h:49
TUrl fUrlOrg
Definition: TWebFile.h:52
virtual Int_t GetFromWeb10(char *buf, Int_t len, const TString &msg, Int_t nseg=0, Long64_t *seg_pos=0, Int_t *seg_len=0)
Read multiple byte range request from web server.
Definition: TWebFile.cxx:674
Int_t ReOpen(Option_t *mode) override
Reopen a file with a different access mode, like from READ to UPDATE or from NEW, CREATE,...
Definition: TWebFile.cxx:392
static Long64_t GetMaxFullCacheSize()
Static method returning maxmimal size of full cache, which can be preserved by file instance.
Definition: TWebFile.cxx:1422
Bool_t fHasModRoot
Definition: TWebFile.h:45
virtual void ProcessHttpHeader(const TString &headerLine)
Process the HTTP header in the argument.
Definition: TWebFile.cxx:1414
virtual Int_t GetHunk(TSocket *s, char *hunk, Int_t maxsize)
Read a hunk of data from the socket, up until a terminator.
Definition: TWebFile.cxx:1257
static Long64_t fgMaxFullCacheSize
Definition: TWebFile.h:58
Bool_t fNoProxy
Definition: TWebFile.h:47
virtual ~TWebSystem()
Definition: TWebFile.h:107
void * OpenDirectory(const char *name) override
Open a directory via httpd.
Definition: TWebFile.cxx:1460
Int_t MakeDirectory(const char *name) override
Make a directory via httpd. Not supported.
Definition: TWebFile.cxx:1451
TWebSystem()
Create helper class that allows directory access via httpd.
Definition: TWebFile.cxx:1441
void * GetDirPtr() const override
Definition: TWebFile.h:103
void FreeDirectory(void *dirp) override
Free directory via httpd.
Definition: TWebFile.cxx:1475
Bool_t AccessPathName(const char *path, EAccessMode mode) override
Returns FALSE if one can access a file using the specified access mode.
Definition: TWebFile.cxx:1532
void * fDirp
Definition: TWebFile.h:101
Int_t GetPathInfo(const char *path, FileStat_t &buf) override
Get info about a file.
Definition: TWebFile.cxx:1504
const char * GetDirEntry(void *dirp) override
Get directory entry via httpd. Returns 0 in case no more entries.
Definition: TWebFile.cxx:1488
Int_t Unlink(const char *path) override
Unlink, i.e.
Definition: TWebFile.cxx:1547
TLine * line
static constexpr double s