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
43
47
48#include <vector>
49#include <string>
50#include <map>
51
52//#include <libxml/parser.h>
53//#include <libxml/tree.h>
54
55
56
57#define READV_MAXCHUNKS 512
58#define READV_MAXCHUNKSIZE (1024*128)
59
61 // < 0 means "not specified"
62 long long bytestart;
63 long long byteend;
64};
65
67 std::string path;
68 long long size;
69 long id;
70 long flags;
71 long modtime;
72};
73
74
75class XrdHttpProtocol;
76class XrdOucEnv;
77
79private:
80 // HTTP response parameters to be sent back to the user
82 std::string httpStatusText;
83
84 // Whether transfer encoding was requested.
88
89 int parseContentRange(char *);
90 int parseHost(char *);
91 int parseRWOp(char *);
92
93 //xmlDocPtr xmlbody; /* the resulting document tree */
95
98
99
101
102 // Process the checksum response and return a header that should
103 // be included in the response.
104 int PostProcessChecksum(std::string &digest_header);
105
111 int PostProcessHTTPReq(bool final = false);
112
113 // Parse a resource string, typically a filename, setting the resource field and the opaque data
114 void parseResource(char *url);
115 // Map an XRootD error code to an appropriate HTTP status code and message
117
118 // Sanitize the resource from http[s]://[host]/ questionable prefix
120
126 static void extractChecksumFromList(const std::string & checksumList, std::vector<std::string> & extractedChecksum);
127
134 static void determineXRootDChecksumFromUserDigest(const std::string & userDigest, std::vector<std::string> & xrootdChecksums);
135
136public:
137 XrdHttpReq(XrdHttpProtocol *protinstance) : keepalive(true) {
138
139 prot = protinstance;
140 length = 0;
141 //xmlbody = 0;
142 depth = 0;
143 ralist = 0;
144 opaque = 0;
145 writtenbytes = 0;
146 fopened = false;
147 headerok = false;
148 };
149
150 virtual ~XrdHttpReq();
151
152 virtual void reset();
153
155 int parseLine(char *line, int len);
156
158 int parseFirstLine(char *line, int len);
159
161 int parseBody(char *body, long long len);
162
164 int ReqReadV();
166
168 std::string buildPartialHdr(long long bytestart, long long byteend, long long filesize, char *token);
169
171 std::string buildPartialHdrEnd(char *token);
172
173 // Appends the opaque info that we have
174 // NOTE: this function assumes that the strings are unquoted, and will quote them
175 void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow);
176
177 // ----------------
178 // Description of the request. The header/body parsing
179 // is supposed to populate these fields, for fast access while
180 // processing the request
181
183
184 enum ReqType {
197 rtPOST
198 };
199
202 std::string requestverb;
203
204 // We have to keep the headers for possible further processing
205 // by external plugins
206 std::map<std::string, std::string> allheaders;
207
214
215
218
219
220 // This can be largely optimized...
222 std::vector<ReadWriteOp> rwOps;
225 std::vector<ReadWriteOp> rwOps_split;
226
228 long long length; // Total size from client for PUT; total length of response TO client for GET.
229 int depth;
231
233 std::string host;
235 std::string destination;
236
238 std::string m_req_digest;
239
242
248 std::string m_digest_header;
249
251 std::string hdr2cgistr;
253
254 //
255 // Area for coordinating request and responses to/from the bridge
256 //
257
258
261
264
268 std::string etext;
270
272 const struct iovec *iovP;
273 int iovN;
274 int iovL;
275 bool final;
276
277 // The latest stat info got from the xrd layer
278 long long filesize;
281 char fhandle[4];
283
285 std::string stringresp;
286
289
291 long long writtenbytes;
292
293
294
295
296
303
304
305 // ------------
306 // Items inherited from the Bridge class
307 //
308
309 //-----------------------------------------------------------------------------
335 //-----------------------------------------------------------------------------
336
337 virtual bool Data(XrdXrootd::Bridge::Context &info,
338 const
339 struct iovec *iovP,
340 int iovN,
341 int iovL,
342 bool final
343 );
344
345 //-----------------------------------------------------------------------------
355 //-----------------------------------------------------------------------------
356
357 virtual bool Done(XrdXrootd::Bridge::Context &info);
358
359
360 //-----------------------------------------------------------------------------
373 //-----------------------------------------------------------------------------
374
376 int ecode,
377 const char *etext
378 );
379
380 //-----------------------------------------------------------------------------
393 //-----------------------------------------------------------------------------
394
396 int dlen
397 );
398
399 //-----------------------------------------------------------------------------
412 //-----------------------------------------------------------------------------
413
415 int port,
416 const char *hname
417 );
418
419};
420
421
422
423void trim(std::string &str);
424
425#endif /* XRDHTTPREQ_HH */
426
XErrorCode
Definition: XProtocol.hh:987
XResponseType
Definition: XProtocol.hh:896
void trim(std::string &str)
Definition: XrdHttpChecksum.hh:32
Definition: XrdHttpProtocol.hh:77
Definition: XrdHttpReq.hh:78
int reqstate
State machine to talk to the bridge.
Definition: XrdHttpReq.hh:288
char fhandle[4]
Definition: XrdHttpReq.hh:281
int PostProcessHTTPReq(bool final=false)
bool keepalive
Definition: XrdHttpReq.hh:227
std::vector< ReadWriteOp > rwOps
The original list of multiple reads to perform.
Definition: XrdHttpReq.hh:222
unsigned int rwOpPartialDone
Definition: XrdHttpReq.hh:260
ReqType
These are the HTTP/DAV requests that we support.
Definition: XrdHttpReq.hh:184
@ rtUnset
Definition: XrdHttpReq.hh:185
@ rtMalformed
Definition: XrdHttpReq.hh:187
@ rtDELETE
Definition: XrdHttpReq.hh:193
@ rtOPTIONS
Definition: XrdHttpReq.hh:191
@ rtMOVE
Definition: XrdHttpReq.hh:196
@ rtHEAD
Definition: XrdHttpReq.hh:189
@ rtGET
Definition: XrdHttpReq.hh:188
@ rtPATCH
Definition: XrdHttpReq.hh:192
@ rtPROPFIND
Definition: XrdHttpReq.hh:194
@ rtPUT
Definition: XrdHttpReq.hh:190
@ rtUnknown
Definition: XrdHttpReq.hh:186
@ rtPOST
Definition: XrdHttpReq.hh:197
@ rtMKCOL
Definition: XrdHttpReq.hh:195
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.
std::string httpStatusText
Definition: XrdHttpReq.hh:82
long long length
Definition: XrdHttpReq.hh:228
std::string destination
The destination field specified in the req.
Definition: XrdHttpReq.hh:235
XrdOucString resource
The resource specified by the request, stripped of opaque data.
Definition: XrdHttpReq.hh:209
std::vector< ReadWriteOp > rwOps_split
Definition: XrdHttpReq.hh:225
bool headerok
Tells if we have finished reading the header.
Definition: XrdHttpReq.hh:217
void clientMarshallReadAheadList(int nitems)
virtual void reset()
virtual bool Redir(XrdXrootd::Bridge::Context &info, int port, const char *hname)
XrdHttpProtocol * prot
Definition: XrdHttpReq.hh:94
std::string m_digest_header
The computed digest for the HTTP response header.
Definition: XrdHttpReq.hh:248
std::string etext
Definition: XrdHttpReq.hh:268
std::string stringresp
If we want to give a string as a response, we compose it here.
Definition: XrdHttpReq.hh:285
XResponseType xrdresp
The last response data we got.
Definition: XrdHttpReq.hh:266
XrdHttpReq(XrdHttpProtocol *protinstance)
Definition: XrdHttpReq.hh:137
std::string requestverb
Definition: XrdHttpReq.hh:202
ReqType request
The request we got.
Definition: XrdHttpReq.hh:201
int ProcessHTTPReq()
virtual bool Done(XrdXrootd::Bridge::Context &info)
the result context
long long writtenbytes
In a long write, we track where we have arrived.
Definition: XrdHttpReq.hh:291
XrdOucEnv * opaque
The opaque data, after parsing.
Definition: XrdHttpReq.hh:211
long fileflags
Definition: XrdHttpReq.hh:279
int PostProcessChecksum(std::string &digest_header)
int iovL
byte count
Definition: XrdHttpReq.hh:274
void sanitizeResourcePfx()
static void determineXRootDChecksumFromUserDigest(const std::string &userDigest, std::vector< std::string > &xrootdChecksums)
int depth
Definition: XrdHttpReq.hh:229
virtual bool Error(XrdXrootd::Bridge::Context &info, int ecode, const char *etext)
bool fopened
Definition: XrdHttpReq.hh:282
const struct iovec * iovP
The latest data chunks got from the xrd layer. These are valid only inside the callbacks!
Definition: XrdHttpReq.hh:272
int parseHost(char *)
int httpStatusCode
Definition: XrdHttpReq.hh:81
std::string m_req_digest
The requested digest type.
Definition: XrdHttpReq.hh:238
XrdOucString resourceplusopaque
The resource specified by the request, including all the opaque data.
Definition: XrdHttpReq.hh:213
void getfhandle()
int parseRWOp(char *)
std::string hdr2cgistr
Additional opaque info that may come from the hdr2cgi directive.
Definition: XrdHttpReq.hh:251
std::string host
The host field specified in the req.
Definition: XrdHttpReq.hh:233
long filemodtime
Definition: XrdHttpReq.hh:280
int parseFirstLine(char *line, int len)
Parse the first line of the header.
XrdOucString redirdest
Definition: XrdHttpReq.hh:269
long long m_current_chunk_size
Definition: XrdHttpReq.hh:87
void parseResource(char *url)
virtual int File(XrdXrootd::Bridge::Context &info, int dlen)
int parseLine(char *line, int len)
Parse the header.
std::string buildPartialHdrEnd(char *token)
Build the closing part for a multipart response.
int ReqReadV()
Prepare the buffers for sending a readv request.
XrdHttpChecksumHandler::XrdHttpChecksumRawPtr m_req_cksum
The checksum that was ran for this request.
Definition: XrdHttpReq.hh:241
bool m_transfer_encoding_chunked
Definition: XrdHttpReq.hh:85
void mapXrdErrorToHttpStatus()
bool m_appended_hdr2cgistr
Definition: XrdHttpReq.hh:252
void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow)
readahead_list * ralist
Definition: XrdHttpReq.hh:165
int iovN
array count
Definition: XrdHttpReq.hh:273
virtual bool Data(XrdXrootd::Bridge::Context &info, const struct iovec *iovP, int iovN, int iovL, bool final)
XrdOucString m_resource_with_digest
Definition: XrdHttpReq.hh:246
long long filesize
Definition: XrdHttpReq.hh:278
long long m_current_chunk_offset
Definition: XrdHttpReq.hh:86
static void extractChecksumFromList(const std::string &checksumList, std::vector< std::string > &extractedChecksum)
XErrorCode xrderrcode
Definition: XrdHttpReq.hh:267
void clientUnMarshallReadAheadList(int nitems)
std::map< std::string, std::string > allheaders
Definition: XrdHttpReq.hh:206
unsigned int rwOpDone
To coordinate multipart responses across multiple calls.
Definition: XrdHttpReq.hh:260
virtual ~XrdHttpReq()
int parseContentRange(char *)
bool sendcontinue
Definition: XrdHttpReq.hh:230
ClientRequest xrdreq
The last issued xrd request, often pending.
Definition: XrdHttpReq.hh:263
std::string buildPartialHdr(long long bytestart, long long byteend, long long filesize, char *token)
Build a partial header for a multipart response.
Definition: XrdOucEnv.hh:42
Definition: XrdOucString.hh:254
Definition: XrdSecEntity.hh:64
Definition: XrdXrootdBridge.hh:226
Definition: XrdXrootdBridge.hh:294
std::size_t hash(const BasicJsonType &j)
hash a JSON value
Definition: XrdOucJson.hh:5221
Definition: XrdHttpReq.hh:66
long long size
Definition: XrdHttpReq.hh:68
long flags
Definition: XrdHttpReq.hh:70
long id
Definition: XrdHttpReq.hh:69
std::string path
Definition: XrdHttpReq.hh:67
long modtime
Definition: XrdHttpReq.hh:71
Definition: XrdHttpReq.hh:60
long long byteend
Definition: XrdHttpReq.hh:63
long long bytestart
Definition: XrdHttpReq.hh:62
Definition: XProtocol.hh:658
Definition: XProtocol.hh:843