XRootD
XrdHttpReq.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of XrdHTTP: A pragmatic implementation of the
3 // HTTP/WebDAV protocol for the Xrootd framework
4 //
5 // Copyright (c) 2013 by European Organization for Nuclear Research (CERN)
6 // Author: Fabrizio Furano <furano@cern.ch>
7 // File Date: Nov 2012
8 //------------------------------------------------------------------------------
9 // XRootD is free software: you can redistribute it and/or modify
10 // it under the terms of the GNU Lesser General Public License as published by
11 // the Free Software Foundation, either version 3 of the License, or
12 // (at your option) any later version.
13 //
14 // XRootD is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public License
20 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
21 //------------------------------------------------------------------------------
22 
23 
24 
25 
26 
27 
28 
38 #ifndef XRDHTTPREQ_HH
39 #define XRDHTTPREQ_HH
40 
41 
42 #include "XrdOuc/XrdOucString.hh"
43 
44 #include "XProtocol/XProtocol.hh"
48 
49 #include <vector>
50 #include <string>
51 #include <map>
52 
53 //#include <libxml/parser.h>
54 //#include <libxml/tree.h>
55 
56 
57 
58 
59 struct DirListInfo {
60  std::string path;
61  long long size;
62  long id;
63  long flags;
64  long modtime;
65 };
66 
67 
68 class XrdHttpProtocol;
69 class XrdOucEnv;
70 
72 private:
73  // HTTP response parameters to be sent back to the user
74  int httpStatusCode;
75  std::string httpStatusText;
76 
77  // The value of the user agent, if specified
78  std::string m_user_agent;
79 
80  // Whether transfer encoding was requested.
81  bool m_transfer_encoding_chunked;
82  long long m_current_chunk_offset;
83  long long m_current_chunk_size;
84 
85  // Whether trailer headers were enabled
86  bool m_trailer_headers{false};
87 
88  // Whether the client understands our special status trailer.
89  // The status trailer allows us to report when an IO error occurred
90  // after a response body has started
91  bool m_status_trailer{false};
92 
93  int parseHost(char *);
94 
95  void parseScitag(const std::string & val);
96 
97  //xmlDocPtr xmlbody; /* the resulting document tree */
98  XrdHttpProtocol *prot;
99 
100  void clientMarshallReadAheadList(int nitems);
101  void clientUnMarshallReadAheadList(int nitems);
102 
103 
104  void getfhandle();
105 
106  // Process the checksum response and return a header that should
107  // be included in the response.
108  int PostProcessChecksum(std::string &digest_header);
109 
110  // Process the listing request of a GET request against a directory
111  // - final_: True if this is the last entry in the listing.
112  int PostProcessListing(bool final_);
113 
114  // Send the response for a GET request for a file read (i.e., not a directory)
115  // Invoked after the open is successful but before the first read is issued.
116  int ReturnGetHeaders();
117 
123  int PostProcessHTTPReq(bool final = false);
124 
125  // Parse a resource string, typically a filename, setting the resource field and the opaque data
126  void parseResource(char *url);
127  // Map an XRootD error code to an appropriate HTTP status code and message
128  void mapXrdErrorToHttpStatus();
129 
130  // Sanitize the resource from http[s]://[host]/ questionable prefix
131  void sanitizeResourcePfx();
132 
133  // parses the iovN data pointers elements as either a kXR_read or kXR_readv
134  // response and fills out a XrdHttpIOList with the corresponding length and
135  // buffer pointers. File offsets from kXR_readv responses are not recorded.
136  void getReadResponse(XrdHttpIOList &received);
137 
138  // notifies the range handler of receipt of bytes and sends the client
139  // the data.
140  int sendReadResponseSingleRange(const XrdHttpIOList &received);
141 
142  // notifies the range handler of receipt of bytes and sends the client
143  // the data and necessary headers, assuming multipart/byteranges content type.
144  int sendReadResponsesMultiRanges(const XrdHttpIOList &received);
145 
151  static void extractChecksumFromList(const std::string & checksumList, std::vector<std::string> & extractedChecksum);
152 
159  static void determineXRootDChecksumFromUserDigest(const std::string & userDigest, std::vector<std::string> & xrootdChecksums);
160 
161 public:
163  readRangeHandler(rcfg), keepalive(true) {
164 
165  prot = protinstance;
166  length = 0;
167  //xmlbody = 0;
168  depth = 0;
169  opaque = 0;
170  writtenbytes = 0;
171  fopened = false;
172  headerok = false;
173  mScitag = -1;
174  };
175 
176  virtual ~XrdHttpReq();
177 
178  virtual void reset();
179 
181  int parseLine(char *line, int len);
182 
184  int parseFirstLine(char *line, int len);
185 
187  int parseBody(char *body, long long len);
188 
190  int ReqReadV(const XrdHttpIOList &cl);
191  std::vector<readahead_list> ralist;
192 
194  std::string buildPartialHdr(long long bytestart, long long byteend, long long filesize, char *token);
195 
197  std::string buildPartialHdrEnd(char *token);
198 
199  // Appends the opaque info that we have
200  // NOTE: this function assumes that the strings are unquoted, and will quote them
201  void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow);
202 
203  void addCgi(const std::string & key, const std::string & value);
204 
205  // Return the current user agent; if none has been specified, returns an empty string
206  const std::string &userAgent() const {return m_user_agent;}
207 
208  // ----------------
209  // Description of the request. The header/body parsing
210  // is supposed to populate these fields, for fast access while
211  // processing the request
212 
214 
215  enum ReqType {
216  rtUnset = -1,
228  rtPOST
229  };
230 
233  std::string requestverb;
234 
235  // We have to keep the headers for possible further processing
236  // by external plugins
237  std::map<std::string, std::string> allheaders;
238 
245 
246 
248  bool headerok;
249 
253 
254  bool keepalive;
255  long long length; // Total size from client for PUT; total length of response TO client for GET.
256  int depth;
258 
260  std::string host;
262  std::string destination;
263 
265  std::string m_req_digest;
266 
269 
275  std::string m_digest_header;
276 
278  std::string hdr2cgistr;
280 
281  //
282  // Area for coordinating request and responses to/from the bridge
283  //
284 
285 
287  unsigned int rwOpDone, rwOpPartialDone;
288 
291 
295  std::string etext;
297 
299  const struct iovec *iovP;
300  int iovN;
301  int iovL;
302  bool final;
303 
304  // The latest stat info got from the xrd layer
305  long long filesize;
306  long fileflags;
308  long filectime;
309  char fhandle[4];
310  bool fopened;
311 
313  std::string stringresp;
314 
316  int reqstate;
317 
319  long long writtenbytes;
320 
321  int mScitag;
322 
323 
324 
325 
326 
332  int ProcessHTTPReq();
333 
334 
335  // ------------
336  // Items inherited from the Bridge class
337  //
338 
339  //-----------------------------------------------------------------------------
365  //-----------------------------------------------------------------------------
366 
367  virtual bool Data(XrdXrootd::Bridge::Context &info,
368  const
369  struct iovec *iovP,
370  int iovN,
371  int iovL,
372  bool final
373  );
374 
375  //-----------------------------------------------------------------------------
385  //-----------------------------------------------------------------------------
386 
387  virtual bool Done(XrdXrootd::Bridge::Context &info);
388 
389 
390  //-----------------------------------------------------------------------------
403  //-----------------------------------------------------------------------------
404 
405  virtual bool Error(XrdXrootd::Bridge::Context &info,
406  int ecode,
407  const char *etext
408  );
409 
410  //-----------------------------------------------------------------------------
423  //-----------------------------------------------------------------------------
424 
425  virtual int File(XrdXrootd::Bridge::Context &info,
426  int dlen
427  );
428 
429  //-----------------------------------------------------------------------------
442  //-----------------------------------------------------------------------------
443 
444  virtual bool Redir(XrdXrootd::Bridge::Context &info,
445  int port,
446  const char *hname
447  );
448 
449 };
450 
451 
452 
453 void trim(std::string &str);
454 
455 #endif /* XRDHTTPREQ_HH */
456 
XErrorCode
Definition: XProtocol.hh:987
XResponseType
Definition: XProtocol.hh:896
long long size
Definition: XrdHttpReq.hh:61
void trim(std::string &str)
Definition: XrdHttpReq.cc:75
std::string path
Definition: XrdHttpReq.hh:60
long modtime
Definition: XrdHttpReq.hh:64
std::vector< XrdOucIOVec2 > XrdHttpIOList
Definition: XrdHttpUtils.hh:95
int reqstate
State machine to talk to the bridge.
Definition: XrdHttpReq.hh:316
char fhandle[4]
Definition: XrdHttpReq.hh:309
int ReqReadV(const XrdHttpIOList &cl)
Prepare the buffers for sending a readv request.
Definition: XrdHttpReq.cc:387
bool keepalive
Definition: XrdHttpReq.hh:254
unsigned int rwOpPartialDone
Definition: XrdHttpReq.hh:287
ReqType
These are the HTTP/DAV requests that we support.
Definition: XrdHttpReq.hh:215
int parseBody(char *body, long long len)
Parse the body of a request, assuming that it's XML and that it's entirely in memory.
Definition: XrdHttpReq.cc:93
std::vector< readahead_list > ralist
Definition: XrdHttpReq.hh:191
long long length
Definition: XrdHttpReq.hh:255
std::string destination
The destination field specified in the req.
Definition: XrdHttpReq.hh:262
XrdOucString resource
The resource specified by the request, stripped of opaque data.
Definition: XrdHttpReq.hh:240
bool headerok
Tells if we have finished reading the header.
Definition: XrdHttpReq.hh:248
std::string m_digest_header
The computed digest for the HTTP response header.
Definition: XrdHttpReq.hh:275
std::string etext
Definition: XrdHttpReq.hh:295
std::string stringresp
If we want to give a string as a response, we compose it here.
Definition: XrdHttpReq.hh:313
XResponseType xrdresp
The last response data we got.
Definition: XrdHttpReq.hh:293
std::string requestverb
Definition: XrdHttpReq.hh:233
ReqType request
The request we got.
Definition: XrdHttpReq.hh:232
int ProcessHTTPReq()
Definition: XrdHttpReq.cc:926
long long writtenbytes
In a long write, we track where we have arrived.
Definition: XrdHttpReq.hh:319
XrdOucEnv * opaque
The opaque data, after parsing.
Definition: XrdHttpReq.hh:242
long fileflags
Definition: XrdHttpReq.hh:306
int iovL
byte count
Definition: XrdHttpReq.hh:301
bool fopened
Definition: XrdHttpReq.hh:310
const struct iovec * iovP
The latest data chunks got from the xrd layer. These are valid only inside the callbacks!
Definition: XrdHttpReq.hh:299
virtual ~XrdHttpReq()
Definition: XrdHttpReq.cc:109
std::string m_req_digest
The requested digest type.
Definition: XrdHttpReq.hh:265
XrdOucString resourceplusopaque
The resource specified by the request, including all the opaque data.
Definition: XrdHttpReq.hh:244
virtual bool Data(XrdXrootd::Bridge::Context &info, const struct iovec *iovP, int iovN, int iovL, bool final)
Definition: XrdHttpReq.cc:442
long filectime
Definition: XrdHttpReq.hh:308
std::string hdr2cgistr
Additional opaque info that may come from the hdr2cgi directive.
Definition: XrdHttpReq.hh:278
virtual bool Done(XrdXrootd::Bridge::Context &info)
the result context
Definition: XrdHttpReq.cc:488
std::string host
The host field specified in the req.
Definition: XrdHttpReq.hh:260
long filemodtime
Definition: XrdHttpReq.hh:307
int parseFirstLine(char *line, int len)
Parse the first line of the header.
Definition: XrdHttpReq.cc:255
XrdOucString redirdest
Definition: XrdHttpReq.hh:296
int parseLine(char *line, int len)
Parse the header.
Definition: XrdHttpReq.cc:115
std::string buildPartialHdrEnd(char *token)
Build the closing part for a multipart response.
Definition: XrdHttpReq.cc:434
XrdHttpChecksumHandler::XrdHttpChecksumRawPtr m_req_cksum
The checksum that was ran for this request.
Definition: XrdHttpReq.hh:268
bool m_appended_hdr2cgistr
Definition: XrdHttpReq.hh:279
void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow)
Definition: XrdHttpReq.cc:627
int iovN
array count
Definition: XrdHttpReq.hh:300
XrdHttpReq(XrdHttpProtocol *protinstance, const XrdHttpReadRangeHandler::Configuration &rcfg)
Definition: XrdHttpReq.hh:162
XrdOucString m_resource_with_digest
Definition: XrdHttpReq.hh:273
long long filesize
Definition: XrdHttpReq.hh:305
bool readClosing
Definition: XrdHttpReq.hh:252
virtual bool Redir(XrdXrootd::Bridge::Context &info, int port, const char *hname)
Definition: XrdHttpReq.cc:532
XErrorCode xrderrcode
Definition: XrdHttpReq.hh:294
virtual int File(XrdXrootd::Bridge::Context &info, int dlen)
Definition: XrdHttpReq.cc:464
std::map< std::string, std::string > allheaders
Definition: XrdHttpReq.hh:237
unsigned int rwOpDone
To coordinate multipart responses across multiple calls.
Definition: XrdHttpReq.hh:287
void addCgi(const std::string &key, const std::string &value)
Definition: XrdHttpReq.cc:784
bool sendcontinue
Definition: XrdHttpReq.hh:257
ClientRequest xrdreq
The last issued xrd request, often pending.
Definition: XrdHttpReq.hh:290
const std::string & userAgent() const
Definition: XrdHttpReq.hh:206
std::string buildPartialHdr(long long bytestart, long long byteend, long long filesize, char *token)
Build a partial header for a multipart response.
Definition: XrdHttpReq.cc:424
XrdHttpReadRangeHandler readRangeHandler
Tracking the next ranges of data to read during GET.
Definition: XrdHttpReq.hh:251
virtual void reset()
Definition: XrdHttpReq.cc:2710
virtual bool Error(XrdXrootd::Bridge::Context &info, int ecode, const char *etext)
Definition: XrdHttpReq.cc:505