XRootD
Loading...
Searching...
No Matches
XrdHttpReq Class Reference

#include <XrdHttpReq.hh>

+ Inheritance diagram for XrdHttpReq:
+ Collaboration diagram for XrdHttpReq:

Public Types

enum  ReqType : int {
  rtUnset = -1 ,
  rtUnknown = 0 ,
  rtMalformed ,
  rtGET ,
  rtHEAD ,
  rtPUT ,
  rtOPTIONS ,
  rtPATCH ,
  rtDELETE ,
  rtPROPFIND ,
  rtMKCOL ,
  rtMOVE ,
  rtPOST
}
 These are the HTTP/DAV requests that we support. More...
 

Public Member Functions

 XrdHttpReq (XrdHttpProtocol *protinstance, const XrdHttpReadRangeHandler::Configuration &rcfg)
 
virtual ~XrdHttpReq ()
 
void addCgi (const std::string &key, const std::string &value)
 
void appendOpaque (XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow)
 
std::string buildPartialHdr (long long bytestart, long long byteend, long long filesize, char *token)
 Build a partial header for a multipart response.
 
std::string buildPartialHdrEnd (char *token)
 Build the closing part for a multipart response.
 
virtual bool Data (XrdXrootd::Bridge::Context &info, const struct iovec *iovP, int iovN, int iovL, bool final)
 
virtual bool Done (XrdXrootd::Bridge::Context &info)
 the result context
 
virtual bool Error (XrdXrootd::Bridge::Context &info, int ecode, const char *etext)
 
virtual int File (XrdXrootd::Bridge::Context &info, int dlen)
 
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.
 
int parseFirstLine (char *line, int len)
 Parse the first line of the header.
 
int parseLine (char *line, int len)
 Parse the header.
 
int ProcessHTTPReq ()
 
virtual bool Redir (XrdXrootd::Bridge::Context &info, int port, const char *hname)
 
int ReqReadV (const XrdHttpIOList &cl)
 Prepare the buffers for sending a readv request.
 
virtual void reset ()
 
void setTransferStatusHeader (std::string &header)
 
const std::string & userAgent () const
 
- Public Member Functions inherited from XrdXrootd::Bridge::Result
 Result ()
 Constructor & Destructor.
 
virtual ~Result ()
 
virtual void Free (Bridge::Context &info, char *buffP, int buffL)
 
virtual bool Wait (Bridge::Context &info, int wtime, const char *wtext)
 
virtual Bridge::ResultWaitResp (Bridge::Context &info, int wtime, const char *wtext)
 

Public Attributes

std::map< std::string, std::string > allheaders
 
bool closeAfterError
 
int depth
 
std::string destination
 The destination field specified in the req.
 
std::string etext
 
char fhandle [4]
 
long filectime
 
long fileflags
 
long filemodtime
 
long long filesize
 
bool final
 true -> final result
 
bool fopened
 
std::string hdr2cgistr
 Additional opaque info that may come from the hdr2cgi directive.
 
bool headerok
 Tells if we have finished reading the header.
 
std::string host
 The host field specified in the req.
 
int iovL
 byte count
 
int iovN
 array count
 
const struct iovec * iovP
 The latest data chunks got from the xrd layer. These are valid only inside the callbacks!
 
bool keepalive
 
long long length
 
bool m_appended_asize {false}
 Track whether we already appended the oss.asize argument for PUTs.
 
bool m_appended_hdr2cgistr
 
std::string m_digest_header
 The computed digest for the HTTP response header.
 
std::string m_origin
 
XrdHttpChecksumHandler::XrdHttpChecksumRawPtr m_req_cksum = nullptr
 The checksum that was ran for this request.
 
std::string m_req_digest
 The requested digest type.
 
XrdOucString m_resource_with_digest
 
int mScitag
 
XrdOucEnvopaque
 The opaque data, after parsing.
 
std::vector< readahead_listralist
 
bool readClosing
 
XrdHttpReadRangeHandler readRangeHandler
 Tracking the next ranges of data to read during GET.
 
XrdOucString redirdest
 
int reqstate
 State machine to talk to the bridge.
 
ReqType request
 The request we got.
 
std::string requestverb
 
XrdOucString resource
 The resource specified by the request, stripped of opaque data.
 
XrdOucString resourceplusopaque
 The resource specified by the request, including all the opaque data.
 
unsigned int rwOpDone
 To coordinate multipart responses across multiple calls.
 
unsigned int rwOpPartialDone
 
bool sendcontinue
 
std::string stringresp
 If we want to give a string as a response, we compose it here.
 
long long writtenbytes
 In a long write, we track where we have arrived.
 
XErrorCode xrderrcode
 
ClientRequest xrdreq
 The last issued xrd request, often pending.
 
XResponseType xrdresp
 The last response data we got.
 

Detailed Description

Definition at line 71 of file XrdHttpReq.hh.

Member Enumeration Documentation

◆ ReqType

enum XrdHttpReq::ReqType : int

These are the HTTP/DAV requests that we support.

Enumerator
rtUnset 
rtUnknown 
rtMalformed 
rtGET 
rtHEAD 
rtPUT 
rtOPTIONS 
rtPATCH 
rtDELETE 
rtPROPFIND 
rtMKCOL 
rtMOVE 
rtPOST 

Definition at line 81 of file XrdHttpReq.hh.

Constructor & Destructor Documentation

◆ XrdHttpReq()

XrdHttpReq::XrdHttpReq ( XrdHttpProtocol * protinstance,
const XrdHttpReadRangeHandler::Configuration & rcfg )
inline

Definition at line 207 of file XrdHttpReq.hh.

207 :
208 readRangeHandler(rcfg), closeAfterError(false), keepalive(true) {
209
210 prot = protinstance;
211 length = 0;
212 //xmlbody = 0;
213 depth = 0;
214 opaque = 0;
215 writtenbytes = 0;
216 fopened = false;
217 headerok = false;
218 mScitag = -1;
219 };
long long length
bool headerok
Tells if we have finished reading the header.
bool closeAfterError
long long writtenbytes
In a long write, we track where we have arrived.
XrdOucEnv * opaque
The opaque data, after parsing.
XrdHttpReadRangeHandler readRangeHandler
Tracking the next ranges of data to read during GET.

References closeAfterError, depth, fopened, headerok, keepalive, length, mScitag, opaque, readRangeHandler, and writtenbytes.

◆ ~XrdHttpReq()

XrdHttpReq::~XrdHttpReq ( )
virtual

Definition at line 111 of file XrdHttpReq.cc.

111 {
112 //if (xmlbody) xmlFreeDoc(xmlbody);
113
114 reset();
115}
virtual void reset()

References reset().

+ Here is the call graph for this function:

Member Function Documentation

◆ addCgi()

void XrdHttpReq::addCgi ( const std::string & key,
const std::string & value )

Definition at line 762 of file XrdHttpReq.cc.

762 {
763 if (hdr2cgistr.length() > 0) {
764 hdr2cgistr.append("&");
765 }
766 hdr2cgistr.append(key);
767 hdr2cgistr.append("=");
768 hdr2cgistr.append(value);
769}
std::string hdr2cgistr
Additional opaque info that may come from the hdr2cgi directive.

References hdr2cgistr.

Referenced by parseLine().

+ Here is the caller graph for this function:

◆ appendOpaque()

void XrdHttpReq::appendOpaque ( XrdOucString & s,
XrdSecEntity * secent,
char * hash,
time_t tnow )

Definition at line 654 of file XrdHttpReq.cc.

654 {
655
656 int l = 0;
657 char * p = 0;
658 if (opaque)
659 p = opaque->Env(l);
660
661 if (hdr2cgistr.empty() && (l < 2) && !hash) return;
662
663 // this works in most cases, except if the url already contains the xrdhttp tokens
664 s = s + "?";
665 if (!hdr2cgistr.empty()) {
666 s += encode_opaque(hdr2cgistr).c_str();
667 }
668 if (p && (l > 1)) {
669 if (!hdr2cgistr.empty()) {
670 s = s + "&";
671 }
672 s = s + encode_opaque(p + 1).c_str();
673 }
674
675 if (hash) {
676 if (l > 1) s += "&";
677 s += "xrdhttptk=";
678 s += hash;
679
680 s += "&xrdhttptime=";
681 char buf[256];
682 sprintf(buf, "%lld", (long long) tnow);
683 s += buf;
684
685 if (secent) {
686 if (secent->name) {
687 s += "&xrdhttpname=";
688 s += encode_str(secent->name).c_str();
689 }
690 }
691
692 if (secent->vorg) {
693 s += "&xrdhttpvorg=";
694 s += encode_str(secent->vorg).c_str();
695 }
696
697 if (secent->host) {
698 s += "&xrdhttphost=";
699 s += encode_str(secent->host).c_str();
700 }
701
702 if (secent->moninfo) {
703 s += "&xrdhttpdn=";
704 s += encode_str(secent->moninfo).c_str();
705 }
706
707 if (secent->role) {
708 s += "&xrdhttprole=";
709 s += encode_str(secent->role).c_str();
710 }
711
712 if (secent->grps) {
713 s += "&xrdhttpgrps=";
714 s += encode_str(secent->grps).c_str();
715 }
716
717 if (secent->endorsements) {
718 s += "&xrdhttpendorsements=";
719 s += encode_str(secent->endorsements).c_str();
720 }
721
722 if (secent->credslen) {
723 s += "&xrdhttpcredslen=";
724 char buf[16];
725 sprintf(buf, "%d", secent->credslen);
726 s += encode_str(buf).c_str();
727 }
728
729 if (secent->credslen) {
730 if (secent->creds) {
731 s += "&xrdhttpcreds=";
732 // Apparently this string might be not 0-terminated (!)
733 char *zerocreds = strndup(secent->creds, secent->credslen);
734 if (zerocreds) {
735 s += encode_str(zerocreds).c_str();
736 free(zerocreds);
737 }
738 }
739 }
740 }
741 }
std::string encode_opaque(const std::string &opaque)
std::string encode_str(const std::string &str)
char * vorg
Entity's virtual organization(s)
int credslen
Length of the 'creds' data.
char * creds
Raw entity credentials or cert.
char * grps
Entity's group name(s)
char * name
Entity's name.
char * role
Entity's role(s)
char * endorsements
Protocol specific endorsements.
char * moninfo
Information for monitoring.
char * host
Entity's host name dnr dependent.

References XrdSecEntity::creds, XrdSecEntity::credslen, encode_opaque(), encode_str(), XrdSecEntity::endorsements, XrdSecEntity::grps, hdr2cgistr, XrdSecEntity::host, XrdSecEntity::moninfo, XrdSecEntity::name, opaque, XrdSecEntity::role, and XrdSecEntity::vorg.

Referenced by ProcessHTTPReq(), and Redir().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildPartialHdr()

std::string XrdHttpReq::buildPartialHdr ( long long bytestart,
long long byteend,
long long filesize,
char * token )

Build a partial header for a multipart response.

Definition at line 434 of file XrdHttpReq.cc.

434 {
435 std::ostringstream s;
436
437 s << "\r\n--" << token << "\r\n";
438 s << "Content-type: text/plain; charset=UTF-8\r\n";
439 s << "Content-range: bytes " << bytestart << "-" << byteend << "/" << fsz << "\r\n\r\n";
440
441 return s.str();
442}

◆ buildPartialHdrEnd()

std::string XrdHttpReq::buildPartialHdrEnd ( char * token)

Build the closing part for a multipart response.

Definition at line 444 of file XrdHttpReq.cc.

444 {
445 std::ostringstream s;
446
447 s << "\r\n--" << token << "--\r\n";
448
449 return s.str();
450}

◆ Data()

bool XrdHttpReq::Data ( XrdXrootd::Bridge::Context & info,
const struct iovec * iovP,
int iovN,
int iovL,
bool final )
virtual

Effect a client data response.

The Data() method is called when Run() resulted in a successful data response. The method should rewrite the data and send it to the client using the associated XrdLink object. As an example, 1) Result::Data(info, iovP, iovN, iovL) is called. 2) Inspect iovP, rewrite the data. 3) Send the response: info->linkP->Send(new_iovP, new_iovN, new_iovL); 4) Handle send errors and cleanup(e.g. deallocate storage). 5) Return, the exchange is now complete.

Parameters
infothe context associated with the result.
iovPa pointer to the iovec structure containing the xrootd data response about to be sent to the client. The request header is not included in the iovec structure. The elements of this structure must not be modified by the method.
iovNthe number of elements in the iovec structure array.
iovLtotal number of data bytes that would be sent to the client. This is simply the sum of all the lengths in the iovec.
finalTrue is this is the final result. Otherwise, this is a partial result (i.e. kXR_oksofar) and more data will result causing additional callbacks.
Returns
true continue normal processing. false terminate the bridge and close the link.
Parameters
infothe result context
iovPpointer to data array
iovNarray count
iovLbyte count
finaltrue -> final result

Implements XrdXrootd::Bridge::Result.

Definition at line 452 of file XrdHttpReq.cc.

458 {
459
460 TRACE(REQ, " XrdHttpReq::Data! final=" << final);
461
462 this->xrdresp = kXR_ok;
463 this->iovP = iovP_;
464 this->iovN = iovN_;
465 this->iovL = iovL_;
466 this->final = final_;
467
468 if (PostProcessHTTPReq(final_)) reset();
469
470 return true;
471
472};
@ kXR_ok
Definition XProtocol.hh:899
#define TRACE(act, x)
Definition XrdTrace.hh:63
XResponseType xrdresp
The last response data we got.
int iovL
byte count
const struct iovec * iovP
The latest data chunks got from the xrd layer. These are valid only inside the callbacks!
int iovN
array count

References iovL, iovN, iovP, kXR_ok, reset(), TRACE, and xrdresp.

+ Here is the call graph for this function:

◆ Done()

bool XrdHttpReq::Done ( XrdXrootd::Bridge::Context & info)
virtual

the result context

Effect a client acknowledgement.

The Done() method is called when Run() resulted in success and there is no associated data for the client (equivalent to a simple kXR_ok response).

Parameters
infothe context associated with the result.
Returns
true continue normal processing. false terminate the bridge and close the link.

Implements XrdXrootd::Bridge::Result.

Definition at line 498 of file XrdHttpReq.cc.

498 {
499
500 TRACE(REQ, " XrdHttpReq::Done");
501
502 xrdresp = kXR_ok;
503
504 this->iovN = 0;
505
506 int r = PostProcessHTTPReq(true);
507 // Beware, we don't have to reset() if the result is 0
508 if (r) reset();
509 if (r < 0) return false;
510
511
512 return true;
513};

References iovN, kXR_ok, reset(), TRACE, and xrdresp.

+ Here is the call graph for this function:

◆ Error()

bool XrdHttpReq::Error ( XrdXrootd::Bridge::Context & info,
int ecode,
const char * etext )
virtual

Effect a client error response.

The Error() method is called when an error was encountered while processing the Run() request. The error should be reflected to the client.

Parameters
infothe context associated with the result.
ecodethe "kXR" error code describing the nature of the error. The code is in host byte format.
etexta null terminated string describing the error in human terms
Returns
true continue normal processing. false terminate the bridge and close the link.
Parameters
infothe result context
ecodethe "kXR" error code
etextassociated error message

Implements XrdXrootd::Bridge::Result.

Definition at line 515 of file XrdHttpReq.cc.

518 {
519
520 TRACE(REQ, " XrdHttpReq::Error");
521
523 xrderrcode = (XErrorCode) ecode;
524
525 if (etext_) {
526 char *s = escapeXML(etext_);
527 this->etext = s;
528 free(s);
529 }
530
531 auto rc = PostProcessHTTPReq();
532 if (rc) {
533 reset();
534 }
535
536 // If we are servicing a GET on a directory, it'll generate an error for the default
537 // OSS (we don't assume this is always true). Catch and suppress the error so we can instead
538 // generate a directory listing (if configured).
539 if ((request == rtGET) && (xrdreq.header.requestid == ntohs(kXR_open)) && (xrderrcode == kXR_isDirectory))
540 return true;
541
542 return rc == 0;
543};
XErrorCode
Definition XProtocol.hh:989
@ kXR_isDirectory
@ kXR_error
Definition XProtocol.hh:903
@ kXR_open
Definition XProtocol.hh:122
char * escapeXML(const char *str)
std::string etext
ReqType request
The request we got.
XErrorCode xrderrcode
ClientRequest xrdreq
The last issued xrd request, often pending.

References escapeXML(), etext, kXR_error, kXR_isDirectory, kXR_open, request, reset(), rtGET, TRACE, xrderrcode, xrdreq, and xrdresp.

+ Here is the call graph for this function:

◆ File()

int XrdHttpReq::File ( XrdXrootd::Bridge::Context & info,
int dlen )
virtual

Notify callback that a sendfile() request is pending.

The File() method is called when Run() resulted in a sendfile response (i.e. sendfile() would have been used to send data to the client). This allows the callback to reframe the sendfile() data using the Send() method in the passed context object (see class Context above).

Parameters
infothe context associated with the result.
dlentotal number of data bytes that would be sent to the client.
Returns
true continue normal processing. false terminate the bridge and close the link.
Parameters
infothe result context
dlenbyte count

Implements XrdXrootd::Bridge::Result.

Definition at line 474 of file XrdHttpReq.cc.

476 {
477
478 // sendfile about to be sent by bridge for fetching data for GET:
479 // no https, no chunked+trailer, no multirange
480
481 //prot->SendSimpleResp(200, NULL, NULL, NULL, dlen);
482 int rc = info.Send(0, 0, 0, 0);
483 TRACE(REQ, " XrdHttpReq::File dlen:" << dlen << " send rc:" << rc);
484 bool start, finish;
485 // short read will be classed as error
486 if (rc) {
487 readRangeHandler.NotifyError();
488 return false;
489 }
490
491 if (readRangeHandler.NotifyReadResult(dlen, nullptr, start, finish) < 0)
492 return false;
493
494
495 return true;
496};
virtual int Send(const struct iovec *headP, int headN, const struct iovec *tailP, int tailN)

References readRangeHandler, XrdXrootd::Bridge::Context::Send(), and TRACE.

+ Here is the call graph for this function:

◆ parseBody()

int XrdHttpReq::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 at line 95 of file XrdHttpReq.cc.

95 {
96 /*
97 * The document being in memory, it has no base per RFC 2396,
98 * and the "noname.xml" argument will serve as its base.
99 */
100 //xmlbody = xmlReadMemory(body, len, "noname.xml", NULL, 0);
101 //if (xmlbody == NULL) {
102 // fprintf(stderr, "Failed to parse document\n");
103 // return 1;
104 //}
105
106
107
108 return 1;
109}

Referenced by ProcessHTTPReq().

+ Here is the caller graph for this function:

◆ parseFirstLine()

int XrdHttpReq::parseFirstLine ( char * line,
int len )

Parse the first line of the header.

Definition at line 265 of file XrdHttpReq.cc.

265 {
266
267 char *key = line;
268
269 int pos;
270
271 // Do the naive parsing
272 if (!line) return -1;
273
274 // Look for the first space-delimited token
275 char *p = strchr((char *) line, (int) ' ');
276 if (!p) {
278 return -1;
279 }
280
281
282 pos = p - line;
283 // The first token cannot be too long
284 if (pos > MAX_TK_LEN - 1) {
286 return -2;
287 }
288
289 // The first space-delimited char cannot be the first one
290 // this allows to deal with the case when a client sends a first line that starts with a space " GET / HTTP/1.1"
291 if(pos == 0) {
293 return -4;
294 }
295
296 // the first token must be non empty
297 if (pos > 0) {
298 line[pos] = 0;
299 char *val = line + pos + 1;
300
301 // Here we are supposed to initialize whatever flag or variable that is needed
302 // by looking at the first token of the line
303
304 // The token is key
305 // The remainder is val, look for the resource
306 p = strchr((char *) val, (int) ' ');
307
308 if (!p) {
310 line[pos] = ' ';
311 return -3;
312 }
313
314 *p = '\0';
315 parseResource(val);
316
317 *p = ' ';
318
319 // Xlate the known header lines
320 if (!strcmp(key, "GET")) {
321 request = rtGET;
322 } else if (!strcmp(key, "HEAD")) {
323 request = rtHEAD;
324 } else if (!strcmp(key, "PUT")) {
325 request = rtPUT;
326 } else if (!strcmp(key, "POST")) {
327 request = rtPOST;
328 } else if (!strcmp(key, "PATCH")) {
330 } else if (!strcmp(key, "OPTIONS")) {
332 } else if (!strcmp(key, "DELETE")) {
334 } else if (!strcmp(key, "PROPFIND")) {
336
337 } else if (!strcmp(key, "MKCOL")) {
339
340 } else if (!strcmp(key, "MOVE")) {
341 request = rtMOVE;
342 } else {
344 }
345
346 requestverb = key;
347
348 // The last token should be the protocol. If it is HTTP/1.0, then
349 // keepalive is disabled by default.
350 if (!strcmp(p+1, "HTTP/1.0\r\n")) {
351 keepalive = false;
352 }
353 line[pos] = ' ';
354 }
355
356 return 0;
357}
#define MAX_TK_LEN
Definition XrdHttpReq.cc:66
std::string requestverb

References keepalive, MAX_TK_LEN, request, requestverb, rtDELETE, rtGET, rtHEAD, rtMalformed, rtMKCOL, rtMOVE, rtOPTIONS, rtPATCH, rtPOST, rtPROPFIND, rtPUT, and rtUnknown.

◆ parseLine()

int XrdHttpReq::parseLine ( char * line,
int len )

Parse the header.

Definition at line 117 of file XrdHttpReq.cc.

117 {
118
119 char *key = line;
120 int pos;
121
122 // Do the parsing
123 if (!line) return -1;
124
125
126 char *p = strchr((char *) line, (int) ':');
127 if (!p) {
128
130 return -1;
131 }
132
133 pos = (p - line);
134 if (pos > (MAX_TK_LEN - 1)) {
135
137 return -2;
138 }
139
140 if (pos > 0) {
141 line[pos] = 0;
142 char *val = line + pos + 1;
143
144 // Trim left
145 while ( (!isgraph(*val) || (!*val)) && (val < line+len)) val++;
146
147 // We memorize the headers also as a string
148 // because external plugins may need to process it differently
149 std::string ss = val;
150 if(ss.length() >= 2 && ss.substr(ss.length() - 2, 2) != "\r\n") {
152 return -3;
153 }
154 trim(ss);
155 allheaders[key] = ss;
156
157 // Here we are supposed to initialize whatever flag or variable that is needed
158 // by looking at the first token of the line
159 // The token is key
160 // The value is val
161
162 // Screen out the needed header lines
163 if (!strcasecmp(key, "connection")) {
164
165 if (!strcasecmp(val, "Keep-Alive\r\n")) {
166 keepalive = true;
167 } else if (!strcasecmp(val, "close\r\n")) {
168 keepalive = false;
169 }
170
171 } else if (!strcasecmp(key, "host")) {
172 parseHost(val);
173 } else if (!strcasecmp(key, "range")) {
174 // (rfc2616 14.35.1) says if Range header contains any range
175 // which is syntactically invalid the Range header should be ignored.
176 // Therefore no need for the range handler to report an error.
177 readRangeHandler.ParseContentRange(val);
178 } else if (!strcasecmp(key, "content-length")) {
179 length = atoll(val);
180
181 } else if (!strcasecmp(key, "destination")) {
182 destination.assign(val, line+len-val);
184 } else if (!strcasecmp(key, "want-digest")) {
185 m_req_digest.assign(val, line + len - val);
187 //Transform the user requests' want-digest to lowercase
188 std::transform(m_req_digest.begin(),m_req_digest.end(),m_req_digest.begin(),::tolower);
189 } else if (!strcasecmp(key, "depth")) {
190 depth = -1;
191 if (strcmp(val, "infinity"))
192 depth = atoll(val);
193
194 } else if (!strcasecmp(key, "expect") && strstr(val, "100-continue")) {
195 sendcontinue = true;
196 } else if (!strcasecmp(key, "te") && strstr(val, "trailers")) {
197 m_trailer_headers = true;
198 } else if (!strcasecmp(key, "transfer-encoding") && strstr(val, "chunked")) {
199 m_transfer_encoding_chunked = true;
200 } else if (!strcasecmp(key, "x-transfer-status") && strstr(val, "true")) {
201 m_transfer_encoding_chunked = true;
202 m_status_trailer = true;
203 } else if (!strcasecmp(key, "scitag")) {
204 if(prot->pmarkHandle != nullptr) {
205 parseScitag(val);
206 }
207 } else if (!strcasecmp(key, "user-agent")) {
208 m_user_agent = val;
209 trim(m_user_agent);
210 } else if (!strcasecmp(key,"origin")) {
211 m_origin = val;
212 trim(m_origin);
213 } else {
214 // Some headers need to be translated into "local" cgi info.
215 auto it = std::find_if(prot->hdr2cgimap.begin(), prot->hdr2cgimap.end(),[key](const auto & item) {
216 return !strcasecmp(key,item.first.c_str());
217 });
218 if (it != prot->hdr2cgimap.end() && (opaque ? (0 == opaque->Get(it->second.c_str())) : true)) {
219 std::string s;
220 s.assign(val, line+len-val);
221 trim(s);
222 addCgi(it->second,s);
223 }
224 }
225
226
227 line[pos] = ':';
228 }
229
230 return 0;
231}
void trim(std::string &str)
Definition XrdHttpReq.cc:77
std::string destination
The destination field specified in the req.
std::string m_req_digest
The requested digest type.
std::string m_origin
std::map< std::string, std::string > allheaders
void addCgi(const std::string &key, const std::string &value)
bool sendcontinue

References addCgi(), allheaders, depth, destination, keepalive, length, m_origin, m_req_digest, MAX_TK_LEN, opaque, readRangeHandler, request, rtMalformed, sendcontinue, and trim().

+ Here is the call graph for this function:

◆ ProcessHTTPReq()

int XrdHttpReq::ProcessHTTPReq ( )

Crunch an http request. Return values: 0->call Process again 1->request processed -1->error

If we have to add extra header information, add it here.

Definition at line 854 of file XrdHttpReq.cc.

854 {
855
856 kXR_int32 l;
857
858 // State variable for tracking the query parameter search
859 // - 0: Indicates we've not yet searched the URL for '?'
860 // - 1: Indicates we have a '?' and hence query parameters
861 // - 2: Indicates we do *not* have '?' present -- no query parameters
862 int query_param_status = 0;
863 if (!m_appended_asize) {
864 m_appended_asize = true;
865 if (request == rtPUT && length) {
866 if (query_param_status == 0) {
867 query_param_status = strchr(resourceplusopaque.c_str(), '?') ? 1 : 2;
868 }
869 resourceplusopaque.append((query_param_status == 1) ? '&' : '?');
870 query_param_status = 1;
871 auto length_str = std::to_string(length);
872 resourceplusopaque.append("oss.asize=");
873 resourceplusopaque.append(length_str.c_str());
874 if (!opaque) {
875 opaque = new XrdOucEnv();
876 }
877 opaque->Put("oss.asize", length_str.c_str());
878 }
879 }
880
882 if (!m_appended_hdr2cgistr && !hdr2cgistr.empty()) {
883 if (query_param_status == 0) {
884 query_param_status = strchr(resourceplusopaque.c_str(), '?') ? 1 : 2;
885 }
886 resourceplusopaque.append((query_param_status == 1) ? '&' : '?');
887
888 std::string hdr2cgistrEncoded = encode_opaque(hdr2cgistr);
889 resourceplusopaque.append(hdr2cgistrEncoded.c_str());
890 if (TRACING(TRACE_DEBUG)) {
891 // The obfuscation of "authz" will only be done if the server http.header2cgi config contains something that maps a header to this "authz" cgi.
892 // Unfortunately the obfuscation code will be called no matter what is configured in http.header2cgi.
893 std::string header2cgistrObf = obfuscateAuth(hdr2cgistr);
894
895 TRACEI(DEBUG, "Appended header fields to opaque info: '"
896 << header2cgistrObf.c_str() << "'");
897
898 }
899
901 }
902
903 // Verify if we have an external handler for this request
904 if (reqstate == 0) {
905 XrdHttpExtHandler *exthandler = prot->FindMatchingExtHandler(*this);
906 if (exthandler) {
907 XrdHttpExtReq xreq(this, prot);
908 int r = exthandler->ProcessReq(xreq);
909 reset();
910 if (!r) return 1; // All went fine, response sent
911 if (r < 0) return -1; // There was a hard error... close the connection
912
913 return 1; // There was an error and a response was sent
914 }
915 }
916
917 //
918 // Here we process the request locally
919 //
920
921 switch (request) {
925 generateWebdavErrMsg();
926 prot->SendSimpleResp(httpStatusCode, NULL, NULL, httpErrorBody.c_str(), httpErrorBody.length(), false);
927 reset();
928 return -1;
929 }
931 {
932 if (reqstate == 0) {
933 // Always start with Stat; in the case of a checksum request, we'll have a follow-up query
934 if (prot->doStat((char *) resourceplusopaque.c_str())) {
935 prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, false);
936 return -1;
937 }
938 return 0;
939 } else {
940 const char *opaque = strchr(resourceplusopaque.c_str(), '?');
941 // Note that doChksum requires that the memory stays alive until the callback is invoked.
943
944 m_req_cksum = prot->cksumHandler.getChecksumToRun(m_req_digest);
945 if(!m_req_cksum) {
946 // No HTTP IANA checksums have been configured by the server admin, return a "METHOD_NOT_ALLOWED" error
947 // We should not send body in response to HEAD request
948 prot->SendSimpleResp(HTTP_METHOD_NOT_ALLOWED, NULL, NULL, NULL, 0, false);
949 return -1;
950 }
951 if (!opaque) {
952 m_resource_with_digest += "?cks.type=";
953 m_resource_with_digest += m_req_cksum->getXRootDConfigDigestName().c_str();
954 } else {
955 m_resource_with_digest += "&cks.type=";
956 m_resource_with_digest += m_req_cksum->getXRootDConfigDigestName().c_str();
957 }
958 if (prot->doChksum(m_resource_with_digest) < 0) {
959 // In this case, the Want-Digest header was set and PostProcess gave the go-ahead to do a checksum.
960 prot->SendSimpleResp(500, NULL, NULL, (char *) "Failed to create initial checksum request.", 0, false);
961 return -1;
962 }
963 return 1;
964 }
965 }
967 {
968 int retval = keepalive ? 1 : -1; // reset() clears keepalive
969
970 if (resource.beginswith("/static/")) {
971
972 // This is a request for a /static resource
973 // If we have to use the embedded ones then we return the ones in memory as constants
974
975 // The sysadmin can always redirect the request to another host that
976 // contains his static resources
977
978 // We also allow xrootd to preread from the local disk all the files
979 // that have to be served as static resources.
980
981 if (prot->embeddedstatic) {
982
983 // Default case: the icon and the css of the HTML rendering of XrdHttp
984 if (resource == "/static/css/xrdhttp.css") {
985 prot->SendSimpleResp(200, NULL, NULL, (char *) static_css_xrdhttp_css, static_css_xrdhttp_css_len, keepalive);
986 reset();
987 return retval;
988 }
989 if (resource == "/static/icons/xrdhttp.ico") {
990 prot->SendSimpleResp(200, NULL, NULL, (char *) favicon_ico, favicon_ico_len, keepalive);
991 reset();
992 return retval;
993 }
994
995 }
996
997 // If we are here then none of the embedded resources match (or they are disabled)
998 // We may have to redirect to a host that is supposed to serve the static resources
999 if (prot->staticredir) {
1000
1001 XrdOucString s = "Location: ";
1002 s.append(prot->staticredir);
1003
1004 if (s.endswith('/'))
1005 s.erasefromend(1);
1006
1007 s.append(encode_str(std::string(resource.c_str())).c_str());
1008 appendOpaque(s, 0, 0, 0);
1009
1010 prot->SendSimpleResp(302, NULL, (char *) s.c_str(), 0, 0, false);
1011 return -1;
1012
1013
1014 } else {
1015
1016 // We lookup the requested path in a hash containing the preread files
1017 if (prot->staticpreload) {
1018 XrdHttpProtocol::StaticPreloadInfo *mydata = prot->staticpreload->Find(resource.c_str());
1019 if (mydata) {
1020 prot->SendSimpleResp(200, NULL, NULL, (char *) mydata->data, mydata->len, keepalive);
1021 reset();
1022 return retval;
1023 }
1024 }
1025
1026 }
1027
1028
1029 }
1030
1031 // The reqstate parameter basically moves us through a simple state machine.
1032 // To optimize things, we start off by opening the file; if it turns out to be a directory, then
1033 // we close the file handle and switch to doing a HTML-based rendering of the directory. This
1034 // avoids needing to always to do "stat" first to determine the next step (since the file-open also
1035 // does a "stat").
1036 // - 0: Perform an open on the resource
1037 // - 1: Perform a checksum request on the resource (only if requested in header; otherwise skipped)
1038 // - 2: Perform a close (for dirlist only)
1039 // - 3: Perform a dirlist.
1040 // - 4+: Reads from file; if at end, perform a close.
1041 switch (reqstate) {
1042 case 0: // Open the path for reading.
1043 {
1044 memset(&xrdreq, 0, sizeof (ClientRequest));
1045 xrdreq.open.requestid = htons(kXR_open);
1046 l = resourceplusopaque.length() + 1;
1047 xrdreq.open.dlen = htonl(l);
1048 xrdreq.open.mode = 0;
1049 xrdreq.open.options = htons(kXR_retstat | kXR_open_read | ((readRangeHandler.getMaxRanges() <= 1) ? kXR_seqio : 0));
1050
1051 if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1052 prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, false);
1053 return -1;
1054 }
1055
1056 // Prepare to chunk up the request
1057 writtenbytes = 0;
1058
1059 // We want to be invoked again after this request is finished
1060 return 0;
1061 }
1062 case 1: // Checksum request
1063 if (!(fileflags & kXR_isDir) && !m_req_digest.empty()) {
1064 // In this case, the Want-Digest header was set.
1065 bool has_opaque = strchr(resourceplusopaque.c_str(), '?');
1066 // Note that doChksum requires that the memory stays alive until the callback is invoked.
1067 m_req_cksum = prot->cksumHandler.getChecksumToRun(m_req_digest);
1068 if(!m_req_cksum) {
1069 // No HTTP IANA checksums have been configured by the server admin, return a "METHOD_NOT_ALLOWED" error
1070 prot->SendSimpleResp(HTTP_METHOD_NOT_ALLOWED, NULL, NULL, (char *) "No HTTP-IANA compatible checksums have been configured.", 0, false);
1071 return -1;
1072 }
1074 if (has_opaque) {
1075 m_resource_with_digest += "&cks.type=";
1076 m_resource_with_digest += m_req_cksum->getXRootDConfigDigestName().c_str();
1077 } else {
1078 m_resource_with_digest += "?cks.type=";
1079 m_resource_with_digest += m_req_cksum->getXRootDConfigDigestName().c_str();
1080 }
1081 if (prot->doChksum(m_resource_with_digest) < 0) {
1082 prot->SendSimpleResp(500, NULL, NULL, (char *) "Failed to start internal checksum request to satisfy Want-Digest header.", 0, false);
1083 return -1;
1084 }
1085 return 0;
1086 } else {
1087 TRACEI(DEBUG, "No checksum requested; skipping to request state 2");
1088 reqstate += 1;
1089 }
1090 // fallthrough
1091 case 2: // Close file handle for directory
1092 if ((fileflags & kXR_isDir) && fopened) {
1093 memset(&xrdreq, 0, sizeof (ClientRequest));
1094 xrdreq.close.requestid = htons(kXR_close);
1095 memcpy(xrdreq.close.fhandle, fhandle, 4);
1096
1097 if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1098 generateWebdavErrMsg();
1099 return sendFooterError("Could not run close request on the bridge");
1100 }
1101 return 0;
1102 } else {
1103 reqstate += 1;
1104 }
1105 // fallthrough
1106 case 3: // List directory
1107 if (fileflags & kXR_isDir) {
1108 if (prot->listdeny) {
1109 prot->SendSimpleResp(503, NULL, NULL, (char *) "Listings are disabled.", 0, false);
1110 return -1;
1111 }
1112
1113 if (prot->listredir) {
1114 XrdOucString s = "Location: ";
1115 s.append(prot->listredir);
1116
1117 if (s.endswith('/'))
1118 s.erasefromend(1);
1119
1120 s.append(encode_str(std::string(resource.c_str())).c_str());
1121 appendOpaque(s, 0, 0, 0);
1122
1123 prot->SendSimpleResp(302, NULL, (char *) s.c_str(), 0, 0, false);
1124 return -1;
1125 }
1126
1127 std::string res;
1128 res = resourceplusopaque.c_str();
1129
1130 // --------- DIRLIST
1131 memset(&xrdreq, 0, sizeof (ClientRequest));
1132 xrdreq.dirlist.requestid = htons(kXR_dirlist);
1133 xrdreq.dirlist.options[0] = kXR_dstat;
1134 l = res.length() + 1;
1135 xrdreq.dirlist.dlen = htonl(l);
1136
1137 if (!prot->Bridge->Run((char *) &xrdreq, (char *) res.c_str(), l)) {
1138 generateWebdavErrMsg();
1139 prot->SendSimpleResp(httpStatusCode, NULL, NULL, httpErrorBody.c_str(), httpErrorBody.length(), false);
1140 sendFooterError("Could not run listing request on the bridge");
1141 return -1;
1142 }
1143
1144 // We don't want to be invoked again after this request is finished
1145 return 1;
1146 }
1147 else {
1148 reqstate += 1;
1149 }
1150 // fallthrough
1151 case 4:
1152 {
1153 auto retval = ReturnGetHeaders();
1154 if (retval) {
1155 return retval;
1156 }
1157 }
1158 // fallthrough
1159 default: // Read() or Close(); reqstate is 4+
1160 {
1161 const XrdHttpIOList &readChunkList = readRangeHandler.NextReadList();
1162
1163 // Close() if we have finished, otherwise read the next chunk
1164
1165 // --------- CLOSE
1166 if ( closeAfterError || readChunkList.empty() )
1167 {
1168
1169 memset(&xrdreq, 0, sizeof (ClientRequest));
1170 xrdreq.close.requestid = htons(kXR_close);
1171 memcpy(xrdreq.close.fhandle, fhandle, 4);
1172
1173 if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1174 TRACEI(REQ, " Failed to run close request on the bridge.");
1175 // Note: we have already completed the request and sent the data to the client.
1176 // Hence, there's no need to send an error. However, since the bridge is potentially
1177 // in a bad state, we close the TCP socket to force the client to reconnect.
1178 return -1;
1179 }
1180
1181 // We have finished
1182 readClosing = true;
1183 return 1;
1184
1185 }
1186 // --------- READ or READV
1187
1188 if ( readChunkList.size() == 1 ) {
1189 // Use a read request for single range
1190
1191 long l;
1192 long long offs;
1193
1194 // --------- READ
1195 memset(&xrdreq, 0, sizeof (xrdreq));
1196 xrdreq.read.requestid = htons(kXR_read);
1197 memcpy(xrdreq.read.fhandle, fhandle, 4);
1198 xrdreq.read.dlen = 0;
1199
1200 offs = readChunkList[0].offset;
1201 l = readChunkList[0].size;
1202
1203 xrdreq.read.offset = htonll(offs);
1204 xrdreq.read.rlen = htonl(l);
1205
1206 // If we are using HTTPS or if the client requested trailers, or if the
1207 // read concerns a multirange reponse, disable sendfile
1208 // (in the latter two cases, the extra framing is only done in PostProcessHTTPReq)
1209 if (prot->ishttps || (m_transfer_encoding_chunked && m_trailer_headers) ||
1210 !readRangeHandler.isSingleRange()) {
1211 if (!prot->Bridge->setSF((kXR_char *) fhandle, false)) {
1212 TRACE(REQ, " XrdBridge::SetSF(false) failed.");
1213
1214 }
1215 }
1216
1217
1218
1219 if (l <= 0) {
1220 if (l < 0) {
1221 TRACE(ALL, " Data sizes mismatch.");
1222 return -1;
1223 }
1224 else {
1225 TRACE(ALL, " No more bytes to send.");
1226 reset();
1227 return 1;
1228 }
1229 }
1230
1231 if ((offs >= filesize) || (offs+l > filesize)) {
1232 httpStatusCode = 416;
1233 httpErrorBody = "Range Not Satisfiable";
1234 std::stringstream ss;
1235 ss << "Requested range " << l << "@" << offs << " is past the end of file (" << filesize << ")";
1236 return sendFooterError(ss.str());
1237 }
1238
1239 if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1240 generateWebdavErrMsg();
1241 return sendFooterError("Could not run read request on the bridge");
1242 }
1243 } else {
1244 // --------- READV
1245
1246 length = ReqReadV(readChunkList);
1247
1248 if (!prot->Bridge->Run((char *) &xrdreq, (char *) &ralist[0], length)) {
1249 generateWebdavErrMsg();
1250 return sendFooterError("Could not run ReadV request on the bridge");
1251 }
1252
1253 }
1254
1255 // We want to be invoked again after this request is finished
1256 return 0;
1257 } // case 3+
1258
1259 } // switch (reqstate)
1260
1261
1262 } // case XrdHttpReq::rtGET
1263
1264 case XrdHttpReq::rtPUT:
1265 {
1266 //if (prot->ishttps) {
1267 //prot->SendSimpleResp(501, NULL, NULL, (char *) "HTTPS not supported yet for direct writing. Sorry.", 0);
1268 //return -1;
1269 //}
1270
1271 if (!fopened) {
1272
1273 // --------- OPEN for write!
1274 memset(&xrdreq, 0, sizeof (ClientRequest));
1275 xrdreq.open.requestid = htons(kXR_open);
1276 l = resourceplusopaque.length() + 1;
1277 xrdreq.open.dlen = htonl(l);
1278 xrdreq.open.mode = htons(kXR_ur | kXR_uw | kXR_gw | kXR_gr | kXR_or);
1279 if (! XrdHttpProtocol::usingEC)
1280 xrdreq.open.options = htons(kXR_mkpath | kXR_open_wrto | kXR_delete);
1281 else
1282 xrdreq.open.options = htons(kXR_mkpath | kXR_open_wrto | kXR_new);
1283
1284 if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1285 prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, keepalive);
1286 return -1;
1287 }
1288
1289
1290 // We want to be invoked again after this request is finished
1291 // Only if there is data to fetch from the socket or there will
1292 // never be more data
1293 if (prot->BuffUsed() > 0 || (length == 0 && !sendcontinue))
1294 return 0;
1295
1296 return 1;
1297
1298 } else {
1299
1300 if (m_transfer_encoding_chunked) {
1301 if (m_current_chunk_size == m_current_chunk_offset) {
1302 // Chunk has been consumed; we now must process the CRLF.
1303 // Note that we don't support trailer headers.
1304 if (prot->BuffUsed() < 2) return 1;
1305 if (prot->myBuffStart[0] != '\r' || prot->myBuffStart[1] != '\n') {
1306 prot->SendSimpleResp(400, NULL, NULL, (char *) "Invalid trailing chunk encoding.", 0, keepalive);
1307 return -1;
1308 }
1309 prot->BuffConsume(2);
1310 if (m_current_chunk_size == 0) {
1311 // All data has been sent. Turn off chunk processing and
1312 // set the bytes written and length appropriately; on next callback,
1313 // we will hit the close() block below.
1314 m_transfer_encoding_chunked = false;
1316 return ProcessHTTPReq();
1317 }
1318 m_current_chunk_size = -1;
1319 m_current_chunk_offset = 0;
1320 // If there is more data, we try to process the next chunk; otherwise, return
1321 if (!prot->BuffUsed()) return 1;
1322 }
1323 if (-1 == m_current_chunk_size) {
1324
1325 // Parse out the next chunk size.
1326 long long idx = 0;
1327 bool found_newline = false;
1328 // Set a maximum size of chunk we will allow
1329 // Nginx sets this to "NGX_MAX_OFF_T_VALUE", which is 9223372036854775807 (a some crazy number)
1330 // We set it to 1TB, which is 1099511627776
1331 // This is to prevent a malicious client from sending a very large chunk size
1332 // or a malformed chunk request.
1333 // 1TB in base-16 is 0x40000000000, so only allow 11 characters, plus the CRLF
1334 long long max_chunk_size_chars = std::min(static_cast<long long>(prot->BuffUsed()), static_cast<long long>(13));
1335 for (; idx < max_chunk_size_chars; idx++) {
1336 if (prot->myBuffStart[idx] == '\n') {
1337 found_newline = true;
1338 break;
1339 }
1340 }
1341 // If we found a new line, but it is the first character in the buffer (no chunk length)
1342 // or if the previous character is not a CR.
1343 if (found_newline && ((idx == 0) || prot->myBuffStart[idx-1] != '\r')) {
1344 prot->SendSimpleResp(400, NULL, NULL, (char *)"Invalid chunked encoding", 0, false);
1345 TRACE(REQ, "XrdHTTP PUT: Sending invalid chunk encoding. Start of chunk should have had a length, followed by a CRLF.");
1346 return -1;
1347 }
1348 if (found_newline) {
1349 char *endptr = NULL;
1350 std::string line_contents(prot->myBuffStart, idx);
1351 long long chunk_contents = strtoll(line_contents.c_str(), &endptr, 16);
1352 // Chunk sizes can be followed by trailer information or CRLF
1353 if (*endptr != ';' && *endptr != '\r') {
1354 prot->SendSimpleResp(400, NULL, NULL, (char *)"Invalid chunked encoding", 0, false);
1355 TRACE(REQ, "XrdHTTP PUT: Sending invalid chunk encoding. Chunk size was not followed by a ';' or CR." << __LINE__);
1356 return -1;
1357 }
1358 m_current_chunk_size = chunk_contents;
1359 m_current_chunk_offset = 0;
1360 prot->BuffConsume(idx + 1);
1361 TRACE(REQ, "XrdHTTP PUT: next chunk from client will be " << m_current_chunk_size << " bytes");
1362 } else {
1363 // Need more data!
1364 return 1;
1365 }
1366 }
1367
1368 if (m_current_chunk_size == 0) {
1369 // All data has been sent. Invoke this routine again immediately to process CRLF
1370 return ProcessHTTPReq();
1371 } else {
1372 // At this point, we have a chunk size defined and should consume payload data
1373 memset(&xrdreq, 0, sizeof (xrdreq));
1374 xrdreq.write.requestid = htons(kXR_write);
1375 memcpy(xrdreq.write.fhandle, fhandle, 4);
1376
1377 long long chunk_bytes_remaining = m_current_chunk_size - m_current_chunk_offset;
1378 long long bytes_to_write = std::min(static_cast<long long>(prot->BuffUsed()),
1379 chunk_bytes_remaining);
1380
1381 xrdreq.write.offset = htonll(writtenbytes);
1382 xrdreq.write.dlen = htonl(bytes_to_write);
1383
1384 TRACEI(REQ, "XrdHTTP PUT: Writing chunk of size " << bytes_to_write << " starting with '" << *(prot->myBuffStart) << "'" << " with " << chunk_bytes_remaining << " bytes remaining in the chunk");
1385 if (!prot->Bridge->Run((char *) &xrdreq, prot->myBuffStart, bytes_to_write)) {
1386 generateWebdavErrMsg();
1387 return sendFooterError("Could not run write request on the bridge");
1388 }
1389 // If there are more bytes in the buffer, then immediately call us after the
1390 // write is finished; otherwise, wait for data.
1391 return (prot->BuffUsed() > chunk_bytes_remaining) ? 0 : 1;
1392 }
1393 } else if (writtenbytes < length) {
1394
1395
1396 // --------- WRITE
1397 memset(&xrdreq, 0, sizeof (xrdreq));
1398 xrdreq.write.requestid = htons(kXR_write);
1399 memcpy(xrdreq.write.fhandle, fhandle, 4);
1400
1401 long long bytes_to_read = std::min(static_cast<long long>(prot->BuffUsed()),
1403
1404 xrdreq.write.offset = htonll(writtenbytes);
1405 xrdreq.write.dlen = htonl(bytes_to_read);
1406
1407 TRACEI(REQ, "Writing " << bytes_to_read);
1408 if (!prot->Bridge->Run((char *) &xrdreq, prot->myBuffStart, bytes_to_read)) {
1409 generateWebdavErrMsg();
1410 return sendFooterError("Could not run write request on the bridge");
1411 }
1412
1413 if (writtenbytes + prot->BuffUsed() >= length)
1414 // Trigger an immediate recall after this request has finished
1415 return 0;
1416 else
1417 // We want to be invoked again after this request is finished
1418 // only if there is pending data
1419 return 1;
1420
1421
1422
1423 } else {
1424
1425 // --------- CLOSE
1426 memset(&xrdreq, 0, sizeof (ClientRequest));
1427 xrdreq.close.requestid = htons(kXR_close);
1428 memcpy(xrdreq.close.fhandle, fhandle, 4);
1429
1430
1431 if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1432 generateWebdavErrMsg();
1433 return sendFooterError("Could not run close request on the bridge");
1434 }
1435
1436 // We have finished
1437 return 1;
1438
1439 }
1440
1441 }
1442
1443 break;
1444
1445 }
1447 {
1448 prot->SendSimpleResp(200, NULL, (char *) "DAV: 1\r\nDAV: <http://apache.org/dav/propset/fs/1>\r\nAllow: HEAD,GET,PUT,PROPFIND,DELETE,OPTIONS", NULL, 0, keepalive);
1449 bool ret_keepalive = keepalive; // reset() clears keepalive
1450 reset();
1451 return ret_keepalive ? 1 : -1;
1452 }
1454 {
1455
1456
1457 switch (reqstate) {
1458
1459 case 0: // Stat()
1460 {
1461
1462
1463 // --------- STAT is always the first step
1464 memset(&xrdreq, 0, sizeof (ClientRequest));
1465 xrdreq.stat.requestid = htons(kXR_stat);
1466 std::string s = resourceplusopaque.c_str();
1467
1468
1469 l = resourceplusopaque.length() + 1;
1470 xrdreq.stat.dlen = htonl(l);
1471
1472 if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1473 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1474 return -1;
1475 }
1476
1477 // We need to be invoked again to complete the request
1478 return 0;
1479 }
1480 default:
1481
1482 if (fileflags & kXR_isDir) {
1483 // --------- RMDIR
1484 memset(&xrdreq, 0, sizeof (ClientRequest));
1485 xrdreq.rmdir.requestid = htons(kXR_rmdir);
1486
1487 std::string s = resourceplusopaque.c_str();
1488
1489 l = s.length() + 1;
1490 xrdreq.rmdir.dlen = htonl(l);
1491
1492 if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1493 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run rmdir request.", 0, false);
1494 return -1;
1495 }
1496 } else {
1497 // --------- DELETE
1498 memset(&xrdreq, 0, sizeof (ClientRequest));
1499 xrdreq.rm.requestid = htons(kXR_rm);
1500
1501 std::string s = resourceplusopaque.c_str();
1502
1503 l = s.length() + 1;
1504 xrdreq.rm.dlen = htonl(l);
1505
1506 if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1507 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run rm request.", 0, false);
1508 return -1;
1509 }
1510 }
1511
1512
1513 // We don't want to be invoked again after this request is finished
1514 return 1;
1515
1516 }
1517
1518
1519
1520 }
1522 {
1523 prot->SendSimpleResp(501, NULL, NULL, (char *) "Request not supported yet.", 0, false);
1524
1525 return -1;
1526 }
1528 {
1529
1530
1531
1532 switch (reqstate) {
1533
1534 case 0: // Stat() and add the current item to the list of the things to send
1535 {
1536
1537 if (length > 0) {
1538 TRACE(REQ, "Reading request body " << length << " bytes.");
1539 char *p = 0;
1540 // We have to specifically read all the request body
1541
1542 if (prot->BuffgetData(length, &p, true) < length) {
1543 prot->SendSimpleResp(501, NULL, NULL, (char *) "Error in getting the PROPFIND request body.", 0, false);
1544 return -1;
1545 }
1546
1547 if ((depth > 1) || (depth < 0)) {
1548 prot->SendSimpleResp(501, NULL, NULL, (char *) "Invalid depth value.", 0, false);
1549 return -1;
1550 }
1551
1552
1553 parseBody(p, length);
1554 }
1555
1556
1557 // --------- STAT is always the first step
1558 memset(&xrdreq, 0, sizeof (ClientRequest));
1559 xrdreq.stat.requestid = htons(kXR_stat);
1560 std::string s = resourceplusopaque.c_str();
1561
1562
1563 l = resourceplusopaque.length() + 1;
1564 xrdreq.stat.dlen = htonl(l);
1565
1566 if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1567 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1568 return -1;
1569 }
1570
1571
1572 if (depth == 0) {
1573 // We don't need to be invoked again
1574 return 1;
1575 } else
1576 // We need to be invoked again to complete the request
1577 return 0;
1578
1579
1580
1581 break;
1582 }
1583
1584 default: // Dirlist()
1585 {
1586
1587 // --------- DIRLIST
1588 memset(&xrdreq, 0, sizeof (ClientRequest));
1589 xrdreq.dirlist.requestid = htons(kXR_dirlist);
1590
1591 std::string s = resourceplusopaque.c_str();
1592 xrdreq.dirlist.options[0] = kXR_dstat;
1593 //s += "?xrd.dirstat=1";
1594
1595 l = s.length() + 1;
1596 xrdreq.dirlist.dlen = htonl(l);
1597
1598 if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1599 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1600 return -1;
1601 }
1602
1603 // We don't want to be invoked again after this request is finished
1604 return 1;
1605 }
1606 }
1607
1608
1609 break;
1610 }
1612 {
1613
1614 // --------- MKDIR
1615 memset(&xrdreq, 0, sizeof (ClientRequest));
1616 xrdreq.mkdir.requestid = htons(kXR_mkdir);
1617
1618 std::string s = resourceplusopaque.c_str();
1619 xrdreq.mkdir.options[0] = (kXR_char) kXR_mkdirpath;
1620
1621 l = s.length() + 1;
1622 xrdreq.mkdir.dlen = htonl(l);
1623
1624 if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1625 prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1626 return -1;
1627 }
1628
1629 // We don't want to be invoked again after this request is finished
1630 return 1;
1631 }
1632 case XrdHttpReq::rtMOVE:
1633 {
1634 // Skip the protocol part of destination URL
1635 size_t skip = destination.find("://");
1636 skip = (skip == std::string::npos) ? 0 : skip + 3;
1637
1638 // If we have a manager role, enforce source and destination are on the same host
1639 if (prot->myRole == kXR_isManager && destination.compare(skip, host.size(), host) != 0) {
1640 prot->SendSimpleResp(501, NULL, NULL, (char *) "Only in-place renaming is supported for MOVE.", 0, false);
1641 return -1;
1642 }
1643
1644 // If needed, append opaque info from source onto destination
1645 int pos = resourceplusopaque.find("?");
1646 if (pos != STR_NPOS) {
1647 destination.append((destination.find("?") == std::string::npos) ? "?" : "&");
1648 destination.append(resourceplusopaque.c_str() + pos + 1);
1649 }
1650
1651 size_t path_pos = destination.find('/', skip + 1);
1652
1653 if (path_pos == std::string::npos) {
1654 prot->SendSimpleResp(400, NULL, NULL, (char *) "Cannot determine destination path", 0, false);
1655 return -1;
1656 }
1657
1658 // Construct args to kXR_mv request (i.e. <src> + " " + <dst>)
1659 std::string mv_args = std::string(resourceplusopaque.c_str()) + " " + destination.substr(path_pos);
1660
1661 l = mv_args.length() + 1;
1662
1663 // Prepare and run kXR_mv request
1664 memset(&xrdreq, 0, sizeof (ClientRequest));
1665 xrdreq.mv.requestid = htons(kXR_mv);
1666 xrdreq.mv.arg1len = htons(resourceplusopaque.length());
1667 xrdreq.mv.dlen = htonl(l);
1668
1669 if (!prot->Bridge->Run((char *) &xrdreq, (char *) mv_args.c_str(), l)) {
1670 prot->SendSimpleResp(500, NULL, NULL, (char *) "Could not run request.", 0, false);
1671 return -1;
1672 }
1673
1674 // We don't want to be invoked again after this request is finished
1675 return 1;
1676 }
1677 default:
1678 {
1679 prot->SendSimpleResp(501, NULL, NULL, (char *) "Request not supported.", 0, false);
1680 return -1;
1681 }
1682
1683 }
1684
1685 return 1;
1686}
#define kXR_isManager
@ kXR_open_wrto
Definition XProtocol.hh:469
@ kXR_delete
Definition XProtocol.hh:453
@ kXR_open_read
Definition XProtocol.hh:456
@ kXR_mkpath
Definition XProtocol.hh:460
@ kXR_seqio
Definition XProtocol.hh:468
@ kXR_new
Definition XProtocol.hh:455
@ kXR_retstat
Definition XProtocol.hh:463
@ kXR_dstat
Definition XProtocol.hh:240
@ kXR_read
Definition XProtocol.hh:125
@ kXR_mkdir
Definition XProtocol.hh:120
@ kXR_dirlist
Definition XProtocol.hh:116
@ kXR_rm
Definition XProtocol.hh:126
@ kXR_write
Definition XProtocol.hh:131
@ kXR_rmdir
Definition XProtocol.hh:127
@ kXR_mv
Definition XProtocol.hh:121
@ kXR_stat
Definition XProtocol.hh:129
@ kXR_close
Definition XProtocol.hh:115
@ kXR_mkdirpath
Definition XProtocol.hh:410
@ kXR_gw
Definition XProtocol.hh:444
@ kXR_ur
Definition XProtocol.hh:440
@ kXR_uw
Definition XProtocol.hh:441
@ kXR_gr
Definition XProtocol.hh:443
@ kXR_or
Definition XProtocol.hh:446
@ kXR_isDir
int kXR_int32
Definition XPtypes.hh:89
unsigned char kXR_char
Definition XPtypes.hh:65
#define DEBUG(x)
@ HTTP_METHOD_NOT_ALLOWED
std::vector< XrdOucIOVec2 > XrdHttpIOList
std::string obfuscateAuth(const std::string &input)
#define STR_NPOS
#define TRACE_DEBUG
Definition XrdTrace.hh:36
#define TRACING(x)
Definition XrdTrace.hh:70
#define TRACEI(act, x)
Definition XrdTrace.hh:66
virtual int ProcessReq(XrdHttpExtReq &)=0
int reqstate
State machine to talk to the bridge.
char fhandle[4]
int ReqReadV(const XrdHttpIOList &cl)
Prepare the buffers for sending a readv request.
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:95
std::vector< readahead_list > ralist
XrdOucString resource
The resource specified by the request, stripped of opaque data.
int ProcessHTTPReq()
XrdOucString resourceplusopaque
The resource specified by the request, including all the opaque data.
std::string host
The host field specified in the req.
XrdHttpChecksumHandler::XrdHttpChecksumRawPtr m_req_cksum
The checksum that was ran for this request.
bool m_appended_hdr2cgistr
void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow)
bool m_appended_asize
Track whether we already appended the oss.asize argument for PUTs.
XrdOucString m_resource_with_digest
long long filesize
bool readClosing
int erasefromend(int sz=0)
bool endswith(char c)
void append(const int i)
const char * c_str() const

References XrdOucString::append(), appendOpaque(), XrdOucString::c_str(), closeAfterError, XrdHttpProtocol::StaticPreloadInfo::data, DEBUG, depth, destination, encode_opaque(), encode_str(), XrdOucString::endswith(), XrdOucString::erasefromend(), fhandle, fileflags, filesize, fopened, hdr2cgistr, host, HTTP_METHOD_NOT_ALLOWED, keepalive, kXR_close, kXR_delete, kXR_dirlist, kXR_dstat, kXR_gr, kXR_gw, kXR_isDir, kXR_isManager, kXR_mkdir, kXR_mkdirpath, kXR_mkpath, kXR_mv, kXR_new, kXR_open, kXR_open_read, kXR_open_wrto, kXR_or, kXR_read, kXR_retstat, kXR_rm, kXR_rmdir, kXR_seqio, kXR_stat, kXR_ur, kXR_uw, kXR_write, XrdHttpProtocol::StaticPreloadInfo::len, length, m_appended_asize, m_appended_hdr2cgistr, m_req_cksum, m_req_digest, m_resource_with_digest, obfuscateAuth(), opaque, parseBody(), ProcessHTTPReq(), XrdHttpExtHandler::ProcessReq(), ralist, readClosing, readRangeHandler, ReqReadV(), reqstate, request, reset(), resource, resourceplusopaque, rtDELETE, rtGET, rtHEAD, rtMalformed, rtMKCOL, rtMOVE, rtOPTIONS, rtPATCH, rtPROPFIND, rtPUT, rtUnknown, rtUnset, sendcontinue, STR_NPOS, TRACE, TRACE_DEBUG, TRACEI, TRACING, writtenbytes, and xrdreq.

Referenced by ProcessHTTPReq().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Redir()

bool XrdHttpReq::Redir ( XrdXrootd::Bridge::Context & info,
int port,
const char * hname )
virtual

Redirect the client to another host:port.

The Redir() method is called when the client must be redirected to another host.

Parameters
infothe context associated with the result.
portthe port number in host byte format.
hnamethe DNS name of the host or IP address is IPV4 or IPV6 format (i.e. "n.n.n.n" or "[ipv6_addr]").
Returns
true continue normal processing. false terminate the bridge and close the link.
Parameters
infothe result context
portthe port number
hnamethe destination host

Implements XrdXrootd::Bridge::Result.

Definition at line 545 of file XrdHttpReq.cc.

548 {
549
550
551
552 char buf[512];
553 char hash[512];
554 hash[0] = '\0';
555
556 bool invalid_host = false;
557
558 if (!hname) {
559 invalid_host = true;
560 } else {
561 for (const char *c = hname; *c; ++c)
562 if (*c == '\r' || *c == '\n')
563 invalid_host = true;
564 }
565
566 if (invalid_host) {
567 prot->SendSimpleResp(502, nullptr, nullptr, "Invalid redirect host", 0, false);
568 return keepalive;
569 }
570
571 if (prot->isdesthttps)
572 redirdest = "Location: https://";
573 else
574 redirdest = "Location: http://";
575
576 // port < 0 signals switch to full URL
577 if (port < 0)
578 {
579 if (strncmp(hname, "file://", 7) == 0)
580 {
581 TRACE(REQ, " XrdHttpReq::Redir Switching to file:// ");
582 redirdest = "Location: "; // "file://" already contained in hname
583 }
584 }
585 // Beware, certain Ofs implementations (e.g. EOS) add opaque data directly to the host name
586 // This must be correctly treated here and appended to the opaque info
587 // that we may already have
588 char *pp = strchr((char *)hname, '?');
589 char *vardata = 0;
590 if (pp) {
591 *pp = '\0';
592 redirdest += hname;
593 vardata = pp+1;
594 int varlen = strlen(vardata);
595
596 //Now extract the remaining, vardata points to it
597 while(*vardata == '&' && varlen) {vardata++; varlen--;}
598
599 // Put the question mark back where it was
600 *pp = '?';
601 }
602 else
603 redirdest += hname;
604
605 if (port > 0) {
606 sprintf(buf, ":%d", port);
607 redirdest += buf;
608 }
609
610 redirdest += encode_str(resource.c_str()).c_str();
611
612 // Here we put back the opaque info, if any
613 if (vardata) {
614 redirdest += "?&";
615 redirdest += encode_opaque(vardata).c_str();
616 }
617
618 // Shall we put also the opaque data of the request? Maybe not
619 //int l;
620 //if (opaque && opaque->Env(l))
621 // redirdest += opaque->Env(l);
622
623
624 time_t timenow = 0;
625 if (!prot->isdesthttps && prot->ishttps) {
626 // If the destination is not https, then we suppose that it
627 // will need this token to fill its authorization info
628 timenow = time(0);
629 calcHashes(hash, this->resource.c_str(), (kXR_int16) request,
630 &prot->SecEntity,
631 timenow,
632 prot->secretkey);
633 }
634
635 if (hash[0]) {
636 appendOpaque(redirdest, &prot->SecEntity, hash, timenow);
637 } else
638 appendOpaque(redirdest, 0, 0, 0);
639
640
641 TRACE(REQ, " XrdHttpReq::Redir Redirecting to " << obfuscateAuth(redirdest.c_str()).c_str());
642
643 if (request != rtGET)
644 prot->SendSimpleResp(307, NULL, (char *) redirdest.c_str(), 0, 0, keepalive);
645 else
646 prot->SendSimpleResp(302, NULL, (char *) redirdest.c_str(), 0, 0, keepalive);
647
648 bool ret_keepalive = keepalive; // reset() clears keepalive
649 reset();
650 return ret_keepalive;
651};
short kXR_int16
Definition XPtypes.hh:66
void calcHashes(char *hash, const char *fn, kXR_int16 request, XrdSecEntity *secent, time_t tim, const char *key)
XrdOucString redirdest

References appendOpaque(), calcHashes(), encode_opaque(), encode_str(), keepalive, obfuscateAuth(), redirdest, request, reset(), resource, rtGET, and TRACE.

+ Here is the call graph for this function:

◆ ReqReadV()

int XrdHttpReq::ReqReadV ( const XrdHttpIOList & cl)

Prepare the buffers for sending a readv request.

Definition at line 397 of file XrdHttpReq.cc.

397 {
398
399
400 // Now we build the protocol-ready read ahead list
401 // and also put the correct placeholders inside the cache
402 int n = cl.size();
403 ralist.clear();
404 ralist.reserve(n);
405
406 int j = 0;
407 for (const auto &c: cl) {
408 ralist.emplace_back();
409 auto &ra = ralist.back();
410 memcpy(&ra.fhandle, this->fhandle, 4);
411
412 ra.offset = c.offset;
413 ra.rlen = c.size;
414 j++;
415 }
416
417 if (j > 0) {
418
419 // Prepare a request header
420
421 memset(&xrdreq, 0, sizeof (xrdreq));
422
423 xrdreq.header.requestid = htons(kXR_readv);
424 xrdreq.readv.dlen = htonl(j * sizeof (struct readahead_list));
425
426 clientMarshallReadAheadList(j);
427
428
429 }
430
431 return (j * sizeof (struct readahead_list));
432}
@ kXR_readv
Definition XProtocol.hh:137

References kXR_readv, ralist, and xrdreq.

Referenced by ProcessHTTPReq().

+ Here is the caller graph for this function:

◆ reset()

void XrdHttpReq::reset ( )
virtual

State machine to talk to the bridge

Definition at line 2716 of file XrdHttpReq.cc.

2716 {
2717
2718 TRACE(REQ, " XrdHttpReq request ended.");
2719
2720 //if (xmlbody) xmlFreeDoc(xmlbody);
2721 readRangeHandler.reset();
2722 readClosing = false;
2723 closeAfterError = false;
2724 writtenbytes = 0;
2725 etext.clear();
2726 redirdest = "";
2727
2728 // // Here we should deallocate this
2729 // const struct iovec *iovP //!< pointer to data array
2730 // int iovN, //!< array count
2731 // int iovL, //!< byte count
2732 // bool final //!< true -> final result
2733
2734
2735 //xmlbody = 0;
2736 depth = 0;
2739 ralist.clear();
2740 ralist.shrink_to_fit();
2741
2742 request = rtUnset;
2743 resource = "";
2744 allheaders.clear();
2745
2746 // Reset the state of the request's digest request.
2747 m_req_digest.clear();
2748 m_digest_header.clear();
2749 m_req_cksum = nullptr;
2750
2752 m_user_agent = "";
2753 m_origin = "";
2754
2755 headerok = false;
2756 keepalive = true;
2757 length = 0;
2758 filesize = 0;
2759 depth = 0;
2760 sendcontinue = false;
2761
2762 m_transfer_encoding_chunked = false;
2763 m_current_chunk_size = -1;
2764 m_current_chunk_offset = 0;
2765
2766 m_trailer_headers = false;
2767 m_status_trailer = false;
2768
2770 reqstate = 0;
2771
2772 memset(&xrdreq, 0, sizeof (xrdreq));
2773 memset(&xrdresp, 0, sizeof (xrdresp));
2775
2776 etext.clear();
2777 redirdest = "";
2778
2779 stringresp = "";
2780
2781 host = "";
2782 destination = "";
2783 hdr2cgistr = "";
2784 m_appended_hdr2cgistr = false;
2785 m_appended_asize = false;
2786
2787 iovP = 0;
2788 iovN = 0;
2789 iovL = 0;
2790
2791
2792 if (opaque) delete(opaque);
2793 opaque = 0;
2794
2795 fopened = false;
2796
2797 final = false;
2798
2799 mScitag = -1;
2800
2801 httpStatusCode = -1;
2802 httpErrorCode = "";
2803 httpErrorBody = "";
2804
2805}
@ kXR_noErrorYet
@ kXR_noResponsesYet
Definition XProtocol.hh:908
std::string m_digest_header
The computed digest for the HTTP response header.
std::string stringresp
If we want to give a string as a response, we compose it here.

References allheaders, closeAfterError, depth, destination, etext, filesize, fopened, hdr2cgistr, headerok, host, iovL, iovN, iovP, keepalive, kXR_noErrorYet, kXR_noResponsesYet, length, m_appended_asize, m_appended_hdr2cgistr, m_digest_header, m_origin, m_req_cksum, m_req_digest, m_resource_with_digest, mScitag, opaque, ralist, readClosing, readRangeHandler, redirdest, reqstate, request, resource, rtUnset, sendcontinue, stringresp, TRACE, writtenbytes, xrderrcode, xrdreq, and xrdresp.

Referenced by ~XrdHttpReq(), Data(), Done(), Error(), ProcessHTTPReq(), and Redir().

+ Here is the caller graph for this function:

◆ setTransferStatusHeader()

void XrdHttpReq::setTransferStatusHeader ( std::string & header)

Definition at line 2017 of file XrdHttpReq.cc.

2017 {
2018 if (m_status_trailer) {
2019 if (header.empty()) {
2020 header += "Trailer: X-Transfer-Status";
2021 } else {
2022 header += "\r\nTrailer: X-Transfer-Status";
2023 }
2024 }
2025}

◆ userAgent()

const std::string & XrdHttpReq::userAgent ( ) const
inline

Definition at line 254 of file XrdHttpReq.hh.

254{return m_user_agent;}

Member Data Documentation

◆ allheaders

std::map<std::string, std::string> XrdHttpReq::allheaders

Definition at line 263 of file XrdHttpReq.hh.

Referenced by parseLine(), and reset().

◆ closeAfterError

bool XrdHttpReq::closeAfterError

Definition at line 282 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), ProcessHTTPReq(), and reset().

◆ depth

int XrdHttpReq::depth

Definition at line 286 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), parseLine(), ProcessHTTPReq(), and reset().

◆ destination

std::string XrdHttpReq::destination

The destination field specified in the req.

Definition at line 292 of file XrdHttpReq.hh.

Referenced by parseLine(), ProcessHTTPReq(), and reset().

◆ etext

std::string XrdHttpReq::etext

Definition at line 327 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ fhandle

char XrdHttpReq::fhandle[4]

Definition at line 341 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq().

◆ filectime

long XrdHttpReq::filectime

Definition at line 340 of file XrdHttpReq.hh.

◆ fileflags

long XrdHttpReq::fileflags

Definition at line 338 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq().

◆ filemodtime

long XrdHttpReq::filemodtime

Definition at line 339 of file XrdHttpReq.hh.

◆ filesize

long long XrdHttpReq::filesize

Definition at line 337 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ final

bool XrdHttpReq::final

true -> final result

Definition at line 334 of file XrdHttpReq.hh.

◆ fopened

bool XrdHttpReq::fopened

Definition at line 342 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), ProcessHTTPReq(), and reset().

◆ hdr2cgistr

std::string XrdHttpReq::hdr2cgistr

Additional opaque info that may come from the hdr2cgi directive.

Definition at line 308 of file XrdHttpReq.hh.

Referenced by addCgi(), appendOpaque(), ProcessHTTPReq(), and reset().

◆ headerok

bool XrdHttpReq::headerok

Tells if we have finished reading the header.

Definition at line 274 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), and reset().

◆ host

std::string XrdHttpReq::host

The host field specified in the req.

Definition at line 290 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ iovL

int XrdHttpReq::iovL

byte count

Definition at line 333 of file XrdHttpReq.hh.

Referenced by Data(), and reset().

◆ iovN

int XrdHttpReq::iovN

array count

Definition at line 332 of file XrdHttpReq.hh.

Referenced by Data(), Done(), and reset().

◆ iovP

const struct iovec* XrdHttpReq::iovP

The latest data chunks got from the xrd layer. These are valid only inside the callbacks!

pointer to data array

Definition at line 331 of file XrdHttpReq.hh.

Referenced by Data(), and reset().

◆ keepalive

bool XrdHttpReq::keepalive

Definition at line 284 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), parseFirstLine(), parseLine(), ProcessHTTPReq(), Redir(), and reset().

◆ length

long long XrdHttpReq::length

◆ m_appended_asize

bool XrdHttpReq::m_appended_asize {false}

Track whether we already appended the oss.asize argument for PUTs.

Definition at line 311 of file XrdHttpReq.hh.

311{false};

Referenced by ProcessHTTPReq(), and reset().

◆ m_appended_hdr2cgistr

bool XrdHttpReq::m_appended_hdr2cgistr

Definition at line 309 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ m_digest_header

std::string XrdHttpReq::m_digest_header

The computed digest for the HTTP response header.

Definition at line 305 of file XrdHttpReq.hh.

Referenced by reset().

◆ m_origin

std::string XrdHttpReq::m_origin

Definition at line 355 of file XrdHttpReq.hh.

Referenced by parseLine(), and reset().

◆ m_req_cksum

XrdHttpChecksumHandler::XrdHttpChecksumRawPtr XrdHttpReq::m_req_cksum = nullptr

The checksum that was ran for this request.

Definition at line 298 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ m_req_digest

std::string XrdHttpReq::m_req_digest

The requested digest type.

Definition at line 295 of file XrdHttpReq.hh.

Referenced by parseLine(), ProcessHTTPReq(), and reset().

◆ m_resource_with_digest

XrdOucString XrdHttpReq::m_resource_with_digest

The checksum algorithm is specified as part of the opaque data in the URL. Hence, when a digest is generated to satisfy a request, we cache the tweaked URL in this data member.

Definition at line 303 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ mScitag

int XrdHttpReq::mScitag

Definition at line 353 of file XrdHttpReq.hh.

Referenced by XrdHttpExtReq::XrdHttpExtReq(), XrdHttpReq(), and reset().

◆ opaque

XrdOucEnv* XrdHttpReq::opaque

The opaque data, after parsing.

Definition at line 268 of file XrdHttpReq.hh.

Referenced by XrdHttpExtReq::XrdHttpExtReq(), XrdHttpReq(), appendOpaque(), parseLine(), ProcessHTTPReq(), and reset().

◆ ralist

std::vector<readahead_list> XrdHttpReq::ralist

Definition at line 236 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), ReqReadV(), and reset().

◆ readClosing

bool XrdHttpReq::readClosing

Definition at line 278 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ readRangeHandler

XrdHttpReadRangeHandler XrdHttpReq::readRangeHandler

Tracking the next ranges of data to read during GET.

Definition at line 277 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), File(), parseLine(), ProcessHTTPReq(), and reset().

◆ redirdest

XrdOucString XrdHttpReq::redirdest

Definition at line 328 of file XrdHttpReq.hh.

Referenced by Redir(), and reset().

◆ reqstate

int XrdHttpReq::reqstate

State machine to talk to the bridge.

Definition at line 348 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ request

ReqType XrdHttpReq::request

The request we got.

Definition at line 258 of file XrdHttpReq.hh.

Referenced by Error(), parseFirstLine(), parseLine(), ProcessHTTPReq(), Redir(), and reset().

◆ requestverb

std::string XrdHttpReq::requestverb

Definition at line 259 of file XrdHttpReq.hh.

Referenced by parseFirstLine().

◆ resource

XrdOucString XrdHttpReq::resource

The resource specified by the request, stripped of opaque data.

Definition at line 266 of file XrdHttpReq.hh.

Referenced by XrdHttpExtReq::XrdHttpExtReq(), ProcessHTTPReq(), Redir(), and reset().

◆ resourceplusopaque

XrdOucString XrdHttpReq::resourceplusopaque

The resource specified by the request, including all the opaque data.

Definition at line 270 of file XrdHttpReq.hh.

Referenced by XrdHttpExtReq::XrdHttpExtReq(), and ProcessHTTPReq().

◆ rwOpDone

unsigned int XrdHttpReq::rwOpDone

To coordinate multipart responses across multiple calls.

Definition at line 319 of file XrdHttpReq.hh.

◆ rwOpPartialDone

unsigned int XrdHttpReq::rwOpPartialDone

Definition at line 319 of file XrdHttpReq.hh.

◆ sendcontinue

bool XrdHttpReq::sendcontinue

Definition at line 287 of file XrdHttpReq.hh.

Referenced by parseLine(), ProcessHTTPReq(), and reset().

◆ stringresp

std::string XrdHttpReq::stringresp

If we want to give a string as a response, we compose it here.

Definition at line 345 of file XrdHttpReq.hh.

Referenced by reset().

◆ writtenbytes

long long XrdHttpReq::writtenbytes

In a long write, we track where we have arrived.

Definition at line 351 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), ProcessHTTPReq(), and reset().

◆ xrderrcode

XErrorCode XrdHttpReq::xrderrcode

Definition at line 326 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ xrdreq

ClientRequest XrdHttpReq::xrdreq

The last issued xrd request, often pending.

Definition at line 322 of file XrdHttpReq.hh.

Referenced by Error(), ProcessHTTPReq(), ReqReadV(), and reset().

◆ xrdresp

XResponseType XrdHttpReq::xrdresp

The last response data we got.

Definition at line 325 of file XrdHttpReq.hh.

Referenced by Data(), Done(), Error(), and reset().


The documentation for this class was generated from the following files: