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

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.

81  : int {
82  rtUnset = -1,
83  rtUnknown = 0,
85  rtGET,
86  rtHEAD,
87  rtPUT,
88  rtOPTIONS,
89  rtPATCH,
90  rtDELETE,
91  rtPROPFIND,
92  rtMKCOL,
93  rtMOVE,
94  rtPOST
95  };

Constructor & Destructor Documentation

◆ XrdHttpReq()

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

Definition at line 212 of file XrdHttpReq.hh.

212  :
213  readRangeHandler(rcfg), closeAfterError(false), keepalive(true) {
214 
215  prot = protinstance;
216  length = 0;
217  //xmlbody = 0;
218  depth = 0;
219  opaque = 0;
220  writtenbytes = 0;
221  fopened = false;
222  headerok = false;
223  mScitag = -1;
224  };
bool keepalive
Definition: XrdHttpReq.hh:289
long long length
Definition: XrdHttpReq.hh:290
bool headerok
Tells if we have finished reading the header.
Definition: XrdHttpReq.hh:279
bool closeAfterError
Definition: XrdHttpReq.hh:287
long long writtenbytes
In a long write, we track where we have arrived.
Definition: XrdHttpReq.hh:356
XrdOucEnv * opaque
The opaque data, after parsing.
Definition: XrdHttpReq.hh:273
bool fopened
Definition: XrdHttpReq.hh:347
XrdHttpReadRangeHandler readRangeHandler
Tracking the next ranges of data to read during GET.
Definition: XrdHttpReq.hh:282

References depth, fopened, headerok, length, mScitag, opaque, and writtenbytes.

◆ ~XrdHttpReq()

XrdHttpReq::~XrdHttpReq ( )
virtual

Definition at line 110 of file XrdHttpReq.cc.

110  {
111  //if (xmlbody) xmlFreeDoc(xmlbody);
112 
113  reset();
114 }
virtual void reset()
Definition: XrdHttpReq.cc:2813

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 743 of file XrdHttpReq.cc.

743  {
744  if (hdr2cgistr.length() > 0) {
745  hdr2cgistr.append("&");
746  }
747  hdr2cgistr.append(key);
748  hdr2cgistr.append("=");
749  hdr2cgistr.append(value);
750 }
std::string hdr2cgistr
Additional opaque info that may come from the hdr2cgi directive.
Definition: XrdHttpReq.hh:313

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 635 of file XrdHttpReq.cc.

635  {
636 
637  int l = 0;
638  char * p = 0;
639  if (opaque)
640  p = opaque->Env(l);
641 
642  if (hdr2cgistr.empty() && (l < 2) && !hash) return;
643 
644  // this works in most cases, except if the url already contains the xrdhttp tokens
645  s = s + "?";
646  if (!hdr2cgistr.empty()) {
647  s += encode_opaque(hdr2cgistr).c_str();
648  }
649  if (p && (l > 1)) {
650  if (!hdr2cgistr.empty()) {
651  s = s + "&";
652  }
653  s = s + encode_opaque(p + 1).c_str();
654  }
655 
656  if (hash) {
657  if (l > 1) s += "&";
658  s += "xrdhttptk=";
659  s += hash;
660 
661  s += "&xrdhttptime=";
662  char buf[256];
663  sprintf(buf, "%lld", (long long) tnow);
664  s += buf;
665 
666  if (secent) {
667  if (secent->name) {
668  s += "&xrdhttpname=";
669  s += encode_str(secent->name).c_str();
670  }
671  }
672 
673  if (secent->vorg) {
674  s += "&xrdhttpvorg=";
675  s += encode_str(secent->vorg).c_str();
676  }
677 
678  if (secent->host) {
679  s += "&xrdhttphost=";
680  s += encode_str(secent->host).c_str();
681  }
682 
683  if (secent->moninfo) {
684  s += "&xrdhttpdn=";
685  s += encode_str(secent->moninfo).c_str();
686  }
687 
688  if (secent->role) {
689  s += "&xrdhttprole=";
690  s += encode_str(secent->role).c_str();
691  }
692 
693  if (secent->grps) {
694  s += "&xrdhttpgrps=";
695  s += encode_str(secent->grps).c_str();
696  }
697 
698  if (secent->endorsements) {
699  s += "&xrdhttpendorsements=";
700  s += encode_str(secent->endorsements).c_str();
701  }
702 
703  if (secent->credslen) {
704  s += "&xrdhttpcredslen=";
705  char buf[16];
706  sprintf(buf, "%d", secent->credslen);
707  s += encode_str(buf).c_str();
708  }
709 
710  if (secent->credslen) {
711  if (secent->creds) {
712  s += "&xrdhttpcreds=";
713  // Apparently this string might be not 0-terminated (!)
714  char *zerocreds = strndup(secent->creds, secent->credslen);
715  if (zerocreds) {
716  s += encode_str(zerocreds).c_str();
717  free(zerocreds);
718  }
719  }
720  }
721  }
722  }
std::string encode_opaque(const std::string &opaque)
std::string encode_str(const std::string &str)
char * Env(int &envlen)
Definition: XrdOucEnv.hh:48
char * vorg
Entity's virtual organization(s)
Definition: XrdSecEntity.hh:71
int credslen
Length of the 'creds' data.
Definition: XrdSecEntity.hh:78
char * creds
Raw entity credentials or cert.
Definition: XrdSecEntity.hh:77
char * grps
Entity's group name(s)
Definition: XrdSecEntity.hh:73
char * name
Entity's name.
Definition: XrdSecEntity.hh:69
char * role
Entity's role(s)
Definition: XrdSecEntity.hh:72
char * endorsements
Protocol specific endorsements.
Definition: XrdSecEntity.hh:75
char * moninfo
Information for monitoring.
Definition: XrdSecEntity.hh:76
char * host
Entity's host name dnr dependent.
Definition: XrdSecEntity.hh:70

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

Referenced by XrdHttpProtocol::Process(), 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 430 of file XrdHttpReq.cc.

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

◆ buildPartialHdrEnd()

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

Build the closing part for a multipart response.

Definition at line 440 of file XrdHttpReq.cc.

440  {
441  std::ostringstream s;
442 
443  s << "\r\n--" << token << "--\r\n";
444 
445  return s.str();
446 }

◆ 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 448 of file XrdHttpReq.cc.

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

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 494 of file XrdHttpReq.cc.

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

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 511 of file XrdHttpReq.cc.

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

References escapeXML(), etext, ClientRequest::header, kXR_error, kXR_isDirectory, kXR_open, request, ClientRequestHdr::requestid, 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 470 of file XrdHttpReq.cc.

472  {
473 
474  // sendfile about to be sent by bridge for fetching data for GET:
475  // no https, no chunked+trailer, no multirange
476 
477  //prot->SendSimpleResp(200, NULL, NULL, NULL, dlen);
478  int rc = info.Send(0, 0, 0, 0);
479  TRACE(REQ, " XrdHttpReq::File dlen:" << dlen << " send rc:" << rc);
480  bool start, finish;
481  // short read will be classed as error
482  if (rc) {
484  return false;
485  }
486 
487  if (readRangeHandler.NotifyReadResult(dlen, nullptr, start, finish) < 0)
488  return false;
489 
490 
491  return true;
492 };
void NotifyError()
Force handler to enter error state.
int NotifyReadResult(const ssize_t ret, const UserRange **const urp, bool &start, bool &allend)
Advance internal counters concerning received bytes.
virtual int Send(const struct iovec *headP, int headN, const struct iovec *tailP, int tailN)

References XrdHttpReadRangeHandler::NotifyError(), XrdHttpReadRangeHandler::NotifyReadResult(), 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 94 of file XrdHttpReq.cc.

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

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 261 of file XrdHttpReq.cc.

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

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

Referenced by XrdHttpProtocol::Process().

+ Here is the caller graph for this function:

◆ parseLine()

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

Parse the header.

Definition at line 116 of file XrdHttpReq.cc.

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

References addCgi(), allheaders, depth, destination, XrdOucEnv::Get(), XrdHttpProtocol::hdr2cgimap, keepalive, length, m_req_digest, MAX_TK_LEN, opaque, XrdHttpReadRangeHandler::ParseContentRange(), XrdHttpProtocol::pmarkHandle, readRangeHandler, request, rtMalformed, sendcontinue, and trim().

Referenced by XrdHttpProtocol::Process().

+ Here is the call graph for this function:
+ Here is the caller 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 936 of file XrdHttpReq.cc.

936  {
937 
938  kXR_int32 l;
939 
940  // State variable for tracking the query parameter search
941  // - 0: Indicates we've not yet searched the URL for '?'
942  // - 1: Indicates we have a '?' and hence query parameters
943  // - 2: Indicates we do *not* have '?' present -- no query parameters
944  int query_param_status = 0;
945  if (!m_appended_asize) {
946  m_appended_asize = true;
947  if (request == rtPUT && length) {
948  if (query_param_status == 0) {
949  query_param_status = strchr(resourceplusopaque.c_str(), '?') ? 1 : 2;
950  }
951  resourceplusopaque.append((query_param_status == 1) ? '&' : '?');
952  query_param_status = 1;
953  auto length_str = std::to_string(length);
954  resourceplusopaque.append("oss.asize=");
955  resourceplusopaque.append(length_str.c_str());
956  if (!opaque) {
957  opaque = new XrdOucEnv();
958  }
959  opaque->Put("oss.asize", length_str.c_str());
960  }
961  }
962 
964  if (!m_appended_hdr2cgistr && !hdr2cgistr.empty()) {
965  if (query_param_status == 0) {
966  query_param_status = strchr(resourceplusopaque.c_str(), '?') ? 1 : 2;
967  }
968  resourceplusopaque.append((query_param_status == 1) ? '&' : '?');
969 
970  std::string hdr2cgistrEncoded = encode_opaque(hdr2cgistr);
971  resourceplusopaque.append(hdr2cgistrEncoded.c_str());
972  if (TRACING(TRACE_DEBUG)) {
973  // The obfuscation of "authz" will only be done if the server http.header2cgi config contains something that maps a header to this "authz" cgi.
974  // Unfortunately the obfuscation code will be called no matter what is configured in http.header2cgi.
975  std::string header2cgistrObf = obfuscateAuth(hdr2cgistr);
976 
977  TRACEI(DEBUG, "Appended header fields to opaque info: '"
978  << header2cgistrObf.c_str() << "'");
979 
980  }
981  // We assume that anything appended to the CGI str should also
982  // apply to the destination in case of a MOVE.
983  if (strchr(destination.c_str(), '?')) destination.append("&");
984  else destination.append("?");
985  destination.append(hdr2cgistrEncoded.c_str());
986 
987  m_appended_hdr2cgistr = true;
988  }
989 
990  // Verify if we have an external handler for this request
991  if (reqstate == 0) {
992  XrdHttpExtHandler *exthandler = prot->FindMatchingExtHandler(*this);
993  if (exthandler) {
994  XrdHttpExtReq xreq(this, prot);
995  int r = exthandler->ProcessReq(xreq);
996  reset();
997  if (!r) return 1; // All went fine, response sent
998  if (r < 0) return -1; // There was a hard error... close the connection
999 
1000  return 1; // There was an error and a response was sent
1001  }
1002  }
1003 
1004  //
1005  // Here we process the request locally
1006  //
1007 
1008  switch (request) {
1009  case XrdHttpReq::rtUnset:
1010  case XrdHttpReq::rtUnknown:
1011  {
1012  prot->SendSimpleResp(400, NULL, NULL, (char *) "Request unknown", 0, false);
1013  reset();
1014  return -1;
1015  }
1017  {
1018  prot->SendSimpleResp(400, NULL, NULL, (char *) "Request malformed", 0, false);
1019  reset();
1020  return -1;
1021  }
1022  case XrdHttpReq::rtHEAD:
1023  {
1024  if (reqstate == 0) {
1025  // Always start with Stat; in the case of a checksum request, we'll have a follow-up query
1026  if (prot->doStat((char *) resourceplusopaque.c_str())) {
1027  prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, false);
1028  return -1;
1029  }
1030  return 0;
1031  } else {
1032  const char *opaque = strchr(resourceplusopaque.c_str(), '?');
1033  // Note that doChksum requires that the memory stays alive until the callback is invoked.
1035 
1037  if(!m_req_cksum) {
1038  // No HTTP IANA checksums have been configured by the server admin, return a "METHOD_NOT_ALLOWED" error
1039  prot->SendSimpleResp(403, NULL, NULL, (char *) "No HTTP-IANA compatible checksums have been configured.", 0, false);
1040  return -1;
1041  }
1042  if (!opaque) {
1043  m_resource_with_digest += "?cks.type=";
1045  } else {
1046  m_resource_with_digest += "&cks.type=";
1048  }
1049  if (prot->doChksum(m_resource_with_digest) < 0) {
1050  // In this case, the Want-Digest header was set and PostProcess gave the go-ahead to do a checksum.
1051  prot->SendSimpleResp(500, NULL, NULL, (char *) "Failed to create initial checksum request.", 0, false);
1052  return -1;
1053  }
1054  return 1;
1055  }
1056  }
1057  case XrdHttpReq::rtGET:
1058  {
1059  int retval = keepalive ? 1 : -1; // reset() clears keepalive
1060 
1061  if (resource.beginswith("/static/")) {
1062 
1063  // This is a request for a /static resource
1064  // If we have to use the embedded ones then we return the ones in memory as constants
1065 
1066  // The sysadmin can always redirect the request to another host that
1067  // contains his static resources
1068 
1069  // We also allow xrootd to preread from the local disk all the files
1070  // that have to be served as static resources.
1071 
1072  if (prot->embeddedstatic) {
1073 
1074  // Default case: the icon and the css of the HTML rendering of XrdHttp
1075  if (resource == "/static/css/xrdhttp.css") {
1076  prot->SendSimpleResp(200, NULL, NULL, (char *) static_css_xrdhttp_css, static_css_xrdhttp_css_len, keepalive);
1077  reset();
1078  return retval;
1079  }
1080  if (resource == "/static/icons/xrdhttp.ico") {
1081  prot->SendSimpleResp(200, NULL, NULL, (char *) favicon_ico, favicon_ico_len, keepalive);
1082  reset();
1083  return retval;
1084  }
1085 
1086  }
1087 
1088  // If we are here then none of the embedded resources match (or they are disabled)
1089  // We may have to redirect to a host that is supposed to serve the static resources
1090  if (prot->staticredir) {
1091 
1092  XrdOucString s = "Location: ";
1093  s.append(prot->staticredir);
1094 
1095  if (s.endswith('/'))
1096  s.erasefromend(1);
1097 
1098  s.append(resource);
1099  appendOpaque(s, 0, 0, 0);
1100 
1101  prot->SendSimpleResp(302, NULL, (char *) s.c_str(), 0, 0, false);
1102  return -1;
1103 
1104 
1105  } else {
1106 
1107  // We lookup the requested path in a hash containing the preread files
1108  if (prot->staticpreload) {
1110  if (mydata) {
1111  prot->SendSimpleResp(200, NULL, NULL, (char *) mydata->data, mydata->len, keepalive);
1112  reset();
1113  return retval;
1114  }
1115  }
1116 
1117  }
1118 
1119 
1120  }
1121 
1122  // The reqstate parameter basically moves us through a simple state machine.
1123  // To optimize things, we start off by opening the file; if it turns out to be a directory, then
1124  // we close the file handle and switch to doing a HTML-based rendering of the directory. This
1125  // avoids needing to always to do "stat" first to determine the next step (since the file-open also
1126  // does a "stat").
1127  // - 0: Perform an open on the resource
1128  // - 1: Perform a checksum request on the resource (only if requested in header; otherwise skipped)
1129  // - 2: Perform a close (for dirlist only)
1130  // - 3: Perform a dirlist.
1131  // - 4+: Reads from file; if at end, perform a close.
1132  switch (reqstate) {
1133  case 0: // Open the path for reading.
1134  {
1135  memset(&xrdreq, 0, sizeof (ClientRequest));
1136  xrdreq.open.requestid = htons(kXR_open);
1137  l = resourceplusopaque.length() + 1;
1138  xrdreq.open.dlen = htonl(l);
1139  xrdreq.open.mode = 0;
1141 
1142  if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1143  prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, false);
1144  return -1;
1145  }
1146 
1147  // Prepare to chunk up the request
1148  writtenbytes = 0;
1149 
1150  // We want to be invoked again after this request is finished
1151  return 0;
1152  }
1153  case 1: // Checksum request
1154  if (!(fileflags & kXR_isDir) && !m_req_digest.empty()) {
1155  // In this case, the Want-Digest header was set.
1156  bool has_opaque = strchr(resourceplusopaque.c_str(), '?');
1157  // Note that doChksum requires that the memory stays alive until the callback is invoked.
1159  if(!m_req_cksum) {
1160  // No HTTP IANA checksums have been configured by the server admin, return a "METHOD_NOT_ALLOWED" error
1161  prot->SendSimpleResp(403, NULL, NULL, (char *) "No HTTP-IANA compatible checksums have been configured.", 0, false);
1162  return -1;
1163  }
1165  if (has_opaque) {
1166  m_resource_with_digest += "&cks.type=";
1168  } else {
1169  m_resource_with_digest += "?cks.type=";
1171  }
1172  if (prot->doChksum(m_resource_with_digest) < 0) {
1173  prot->SendSimpleResp(500, NULL, NULL, (char *) "Failed to start internal checksum request to satisfy Want-Digest header.", 0, false);
1174  return -1;
1175  }
1176  return 0;
1177  } else {
1178  TRACEI(DEBUG, "No checksum requested; skipping to request state 2");
1179  reqstate += 1;
1180  }
1181  // fallthrough
1182  case 2: // Close file handle for directory
1183  if ((fileflags & kXR_isDir) && fopened) {
1184  memset(&xrdreq, 0, sizeof (ClientRequest));
1185  xrdreq.close.requestid = htons(kXR_close);
1186  memcpy(xrdreq.close.fhandle, fhandle, 4);
1187 
1188  if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1189  mapXrdErrorToHttpStatus();
1190  return sendFooterError("Could not run close request on the bridge");
1191  }
1192  return 0;
1193  } else {
1194  reqstate += 1;
1195  }
1196  // fallthrough
1197  case 3: // List directory
1198  if (fileflags & kXR_isDir) {
1199  if (prot->listdeny) {
1200  prot->SendSimpleResp(503, NULL, NULL, (char *) "Listings are disabled.", 0, false);
1201  return -1;
1202  }
1203 
1204  if (prot->listredir) {
1205  XrdOucString s = "Location: ";
1206  s.append(prot->listredir);
1207 
1208  if (s.endswith('/'))
1209  s.erasefromend(1);
1210 
1211  s.append(resource);
1212  appendOpaque(s, 0, 0, 0);
1213 
1214  prot->SendSimpleResp(302, NULL, (char *) s.c_str(), 0, 0, false);
1215  return -1;
1216  }
1217 
1218  std::string res;
1219  res = resourceplusopaque.c_str();
1220 
1221  // --------- DIRLIST
1222  memset(&xrdreq, 0, sizeof (ClientRequest));
1225  l = res.length() + 1;
1226  xrdreq.dirlist.dlen = htonl(l);
1227 
1228  if (!prot->Bridge->Run((char *) &xrdreq, (char *) res.c_str(), l)) {
1229  mapXrdErrorToHttpStatus();
1230  prot->SendSimpleResp(httpStatusCode, NULL, NULL, httpErrorBody.c_str(), httpErrorBody.length(), false);
1231  sendFooterError("Could not run listing request on the bridge");
1232  return -1;
1233  }
1234 
1235  // We don't want to be invoked again after this request is finished
1236  return 1;
1237  }
1238  else {
1239  reqstate += 1;
1240  }
1241  // fallthrough
1242  case 4:
1243  {
1244  auto retval = ReturnGetHeaders();
1245  if (retval) {
1246  return retval;
1247  }
1248  }
1249  // fallthrough
1250  default: // Read() or Close(); reqstate is 4+
1251  {
1252  const XrdHttpIOList &readChunkList = readRangeHandler.NextReadList();
1253 
1254  // Close() if we have finished, otherwise read the next chunk
1255 
1256  // --------- CLOSE
1257  if ( closeAfterError || readChunkList.empty() )
1258  {
1259 
1260  memset(&xrdreq, 0, sizeof (ClientRequest));
1261  xrdreq.close.requestid = htons(kXR_close);
1262  memcpy(xrdreq.close.fhandle, fhandle, 4);
1263 
1264  if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1265  TRACEI(REQ, " Failed to run close request on the bridge.");
1266  // Note: we have already completed the request and sent the data to the client.
1267  // Hence, there's no need to send an error. However, since the bridge is potentially
1268  // in a bad state, we close the TCP socket to force the client to reconnect.
1269  return -1;
1270  }
1271 
1272  // We have finished
1273  readClosing = true;
1274  return 1;
1275 
1276  }
1277  // --------- READ or READV
1278 
1279  if ( readChunkList.size() == 1 ) {
1280  // Use a read request for single range
1281 
1282  long l;
1283  long long offs;
1284 
1285  // --------- READ
1286  memset(&xrdreq, 0, sizeof (xrdreq));
1287  xrdreq.read.requestid = htons(kXR_read);
1288  memcpy(xrdreq.read.fhandle, fhandle, 4);
1289  xrdreq.read.dlen = 0;
1290 
1291  offs = readChunkList[0].offset;
1292  l = readChunkList[0].size;
1293 
1294  xrdreq.read.offset = htonll(offs);
1295  xrdreq.read.rlen = htonl(l);
1296 
1297  // If we are using HTTPS or if the client requested trailers, or if the
1298  // read concerns a multirange reponse, disable sendfile
1299  // (in the latter two cases, the extra framing is only done in PostProcessHTTPReq)
1300  if (prot->ishttps || (m_transfer_encoding_chunked && m_trailer_headers) ||
1302  if (!prot->Bridge->setSF((kXR_char *) fhandle, false)) {
1303  TRACE(REQ, " XrdBridge::SetSF(false) failed.");
1304 
1305  }
1306  }
1307 
1308 
1309 
1310  if (l <= 0) {
1311  if (l < 0) {
1312  TRACE(ALL, " Data sizes mismatch.");
1313  return -1;
1314  }
1315  else {
1316  TRACE(ALL, " No more bytes to send.");
1317  reset();
1318  return 1;
1319  }
1320  }
1321 
1322  if ((offs >= filesize) || (offs+l > filesize)) {
1323  httpStatusCode = 416;
1324  httpErrorBody = "Range Not Satisfiable";
1325  std::stringstream ss;
1326  ss << "Requested range " << l << "@" << offs << " is past the end of file (" << filesize << ")";
1327  return sendFooterError(ss.str());
1328  }
1329 
1330  if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1331  mapXrdErrorToHttpStatus();
1332  return sendFooterError("Could not run read request on the bridge");
1333  }
1334  } else {
1335  // --------- READV
1336 
1337  length = ReqReadV(readChunkList);
1338 
1339  if (!prot->Bridge->Run((char *) &xrdreq, (char *) &ralist[0], length)) {
1340  mapXrdErrorToHttpStatus();
1341  return sendFooterError("Could not run ReadV request on the bridge");
1342  }
1343 
1344  }
1345 
1346  // We want to be invoked again after this request is finished
1347  return 0;
1348  } // case 3+
1349 
1350  } // switch (reqstate)
1351 
1352 
1353  } // case XrdHttpReq::rtGET
1354 
1355  case XrdHttpReq::rtPUT:
1356  {
1357  //if (prot->ishttps) {
1358  //prot->SendSimpleResp(501, NULL, NULL, (char *) "HTTPS not supported yet for direct writing. Sorry.", 0);
1359  //return -1;
1360  //}
1361 
1362  if (!fopened) {
1363 
1364  // --------- OPEN for write!
1365  memset(&xrdreq, 0, sizeof (ClientRequest));
1366  xrdreq.open.requestid = htons(kXR_open);
1367  l = resourceplusopaque.length() + 1;
1368  xrdreq.open.dlen = htonl(l);
1369  xrdreq.open.mode = htons(kXR_ur | kXR_uw | kXR_gw | kXR_gr | kXR_or);
1370  if (! XrdHttpProtocol::usingEC)
1372  else
1374 
1375  if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1376  prot->SendSimpleResp(404, NULL, NULL, (char *) "Could not run request.", 0, keepalive);
1377  return -1;
1378  }
1379 
1380 
1381  // We want to be invoked again after this request is finished
1382  // Only if there is data to fetch from the socket or there will
1383  // never be more data
1384  if (prot->BuffUsed() > 0 || (length == 0 && !sendcontinue))
1385  return 0;
1386 
1387  return 1;
1388 
1389  } else {
1390 
1391  if (m_transfer_encoding_chunked) {
1392  if (m_current_chunk_size == m_current_chunk_offset) {
1393  // Chunk has been consumed; we now must process the CRLF.
1394  // Note that we don't support trailer headers.
1395  if (prot->BuffUsed() < 2) return 1;
1396  if (prot->myBuffStart[0] != '\r' || prot->myBuffStart[1] != '\n') {
1397  prot->SendSimpleResp(400, NULL, NULL, (char *) "Invalid trailing chunk encoding.", 0, keepalive);
1398  return -1;
1399  }
1400  prot->BuffConsume(2);
1401  if (m_current_chunk_size == 0) {
1402  // All data has been sent. Turn off chunk processing and
1403  // set the bytes written and length appropriately; on next callback,
1404  // we will hit the close() block below.
1405  m_transfer_encoding_chunked = false;
1406  length = writtenbytes;
1407  return ProcessHTTPReq();
1408  }
1409  m_current_chunk_size = -1;
1410  m_current_chunk_offset = 0;
1411  // If there is more data, we try to process the next chunk; otherwise, return
1412  if (!prot->BuffUsed()) return 1;
1413  }
1414  if (-1 == m_current_chunk_size) {
1415 
1416  // Parse out the next chunk size.
1417  long long idx = 0;
1418  bool found_newline = false;
1419  // Set a maximum size of chunk we will allow
1420  // Nginx sets this to "NGX_MAX_OFF_T_VALUE", which is 9223372036854775807 (a some crazy number)
1421  // We set it to 1TB, which is 1099511627776
1422  // This is to prevent a malicious client from sending a very large chunk size
1423  // or a malformed chunk request.
1424  // 1TB in base-16 is 0x40000000000, so only allow 11 characters, plus the CRLF
1425  long long max_chunk_size_chars = std::min(static_cast<long long>(prot->BuffUsed()), static_cast<long long>(13));
1426  for (; idx < max_chunk_size_chars; idx++) {
1427  if (prot->myBuffStart[idx] == '\n') {
1428  found_newline = true;
1429  break;
1430  }
1431  }
1432  // If we found a new line, but it is the first character in the buffer (no chunk length)
1433  // or if the previous character is not a CR.
1434  if (found_newline && ((idx == 0) || prot->myBuffStart[idx-1] != '\r')) {
1435  prot->SendSimpleResp(400, NULL, NULL, (char *)"Invalid chunked encoding", 0, false);
1436  TRACE(REQ, "XrdHTTP PUT: Sending invalid chunk encoding. Start of chunk should have had a length, followed by a CRLF.");
1437  return -1;
1438  }
1439  if (found_newline) {
1440  char *endptr = NULL;
1441  std::string line_contents(prot->myBuffStart, idx);
1442  long long chunk_contents = strtol(line_contents.c_str(), &endptr, 16);
1443  // Chunk sizes can be followed by trailer information or CRLF
1444  if (*endptr != ';' && *endptr != '\r') {
1445  prot->SendSimpleResp(400, NULL, NULL, (char *)"Invalid chunked encoding", 0, false);
1446  TRACE(REQ, "XrdHTTP PUT: Sending invalid chunk encoding. Chunk size was not followed by a ';' or CR." << __LINE__);
1447  return -1;
1448  }
1449  m_current_chunk_size = chunk_contents;
1450  m_current_chunk_offset = 0;
1451  prot->BuffConsume(idx + 1);
1452  TRACE(REQ, "XrdHTTP PUT: next chunk from client will be " << m_current_chunk_size << " bytes");
1453  } else {
1454  // Need more data!
1455  return 1;
1456  }
1457  }
1458 
1459  if (m_current_chunk_size == 0) {
1460  // All data has been sent. Invoke this routine again immediately to process CRLF
1461  return ProcessHTTPReq();
1462  } else {
1463  // At this point, we have a chunk size defined and should consume payload data
1464  memset(&xrdreq, 0, sizeof (xrdreq));
1465  xrdreq.write.requestid = htons(kXR_write);
1466  memcpy(xrdreq.write.fhandle, fhandle, 4);
1467 
1468  long long chunk_bytes_remaining = m_current_chunk_size - m_current_chunk_offset;
1469  long long bytes_to_write = std::min(static_cast<long long>(prot->BuffUsed()),
1470  chunk_bytes_remaining);
1471 
1472  xrdreq.write.offset = htonll(writtenbytes);
1473  xrdreq.write.dlen = htonl(bytes_to_write);
1474 
1475  TRACEI(REQ, "XrdHTTP PUT: Writing chunk of size " << bytes_to_write << " starting with '" << *(prot->myBuffStart) << "'" << " with " << chunk_bytes_remaining << " bytes remaining in the chunk");
1476  if (!prot->Bridge->Run((char *) &xrdreq, prot->myBuffStart, bytes_to_write)) {
1477  mapXrdErrorToHttpStatus();
1478  return sendFooterError("Could not run write request on the bridge");
1479  }
1480  // If there are more bytes in the buffer, then immediately call us after the
1481  // write is finished; otherwise, wait for data.
1482  return (prot->BuffUsed() > chunk_bytes_remaining) ? 0 : 1;
1483  }
1484  } else if (writtenbytes < length) {
1485 
1486 
1487  // --------- WRITE
1488  memset(&xrdreq, 0, sizeof (xrdreq));
1489  xrdreq.write.requestid = htons(kXR_write);
1490  memcpy(xrdreq.write.fhandle, fhandle, 4);
1491 
1492  long long bytes_to_read = std::min(static_cast<long long>(prot->BuffUsed()),
1493  length - writtenbytes);
1494 
1495  xrdreq.write.offset = htonll(writtenbytes);
1496  xrdreq.write.dlen = htonl(bytes_to_read);
1497 
1498  TRACEI(REQ, "Writing " << bytes_to_read);
1499  if (!prot->Bridge->Run((char *) &xrdreq, prot->myBuffStart, bytes_to_read)) {
1500  mapXrdErrorToHttpStatus();
1501  return sendFooterError("Could not run write request on the bridge");
1502  }
1503 
1504  if (writtenbytes + prot->BuffUsed() >= length)
1505  // Trigger an immediate recall after this request has finished
1506  return 0;
1507  else
1508  // We want to be invoked again after this request is finished
1509  // only if there is pending data
1510  return 1;
1511 
1512 
1513 
1514  } else {
1515 
1516  // --------- CLOSE
1517  memset(&xrdreq, 0, sizeof (ClientRequest));
1518  xrdreq.close.requestid = htons(kXR_close);
1519  memcpy(xrdreq.close.fhandle, fhandle, 4);
1520 
1521 
1522  if (!prot->Bridge->Run((char *) &xrdreq, 0, 0)) {
1523  mapXrdErrorToHttpStatus();
1524  return sendFooterError("Could not run close request on the bridge");
1525  }
1526 
1527  // We have finished
1528  return 1;
1529 
1530  }
1531 
1532  }
1533 
1534  break;
1535 
1536  }
1537  case XrdHttpReq::rtOPTIONS:
1538  {
1539  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);
1540  bool ret_keepalive = keepalive; // reset() clears keepalive
1541  reset();
1542  return ret_keepalive ? 1 : -1;
1543  }
1544  case XrdHttpReq::rtDELETE:
1545  {
1546 
1547 
1548  switch (reqstate) {
1549 
1550  case 0: // Stat()
1551  {
1552 
1553 
1554  // --------- STAT is always the first step
1555  memset(&xrdreq, 0, sizeof (ClientRequest));
1556  xrdreq.stat.requestid = htons(kXR_stat);
1557  std::string s = resourceplusopaque.c_str();
1558 
1559 
1560  l = resourceplusopaque.length() + 1;
1561  xrdreq.stat.dlen = htonl(l);
1562 
1563  if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1564  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1565  return -1;
1566  }
1567 
1568  // We need to be invoked again to complete the request
1569  return 0;
1570  }
1571  default:
1572 
1573  if (fileflags & kXR_isDir) {
1574  // --------- RMDIR
1575  memset(&xrdreq, 0, sizeof (ClientRequest));
1576  xrdreq.rmdir.requestid = htons(kXR_rmdir);
1577 
1578  std::string s = resourceplusopaque.c_str();
1579 
1580  l = s.length() + 1;
1581  xrdreq.rmdir.dlen = htonl(l);
1582 
1583  if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1584  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run rmdir request.", 0, false);
1585  return -1;
1586  }
1587  } else {
1588  // --------- DELETE
1589  memset(&xrdreq, 0, sizeof (ClientRequest));
1590  xrdreq.rm.requestid = htons(kXR_rm);
1591 
1592  std::string s = resourceplusopaque.c_str();
1593 
1594  l = s.length() + 1;
1595  xrdreq.rm.dlen = htonl(l);
1596 
1597  if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1598  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run rm request.", 0, false);
1599  return -1;
1600  }
1601  }
1602 
1603 
1604  // We don't want to be invoked again after this request is finished
1605  return 1;
1606 
1607  }
1608 
1609 
1610 
1611  }
1612  case XrdHttpReq::rtPATCH:
1613  {
1614  prot->SendSimpleResp(501, NULL, NULL, (char *) "Request not supported yet.", 0, false);
1615 
1616  return -1;
1617  }
1619  {
1620 
1621 
1622 
1623  switch (reqstate) {
1624 
1625  case 0: // Stat() and add the current item to the list of the things to send
1626  {
1627 
1628  if (length > 0) {
1629  TRACE(REQ, "Reading request body " << length << " bytes.");
1630  char *p = 0;
1631  // We have to specifically read all the request body
1632 
1633  if (prot->BuffgetData(length, &p, true) < length) {
1634  prot->SendSimpleResp(501, NULL, NULL, (char *) "Error in getting the PROPFIND request body.", 0, false);
1635  return -1;
1636  }
1637 
1638  if ((depth > 1) || (depth < 0)) {
1639  prot->SendSimpleResp(501, NULL, NULL, (char *) "Invalid depth value.", 0, false);
1640  return -1;
1641  }
1642 
1643 
1644  parseBody(p, length);
1645  }
1646 
1647 
1648  // --------- STAT is always the first step
1649  memset(&xrdreq, 0, sizeof (ClientRequest));
1650  xrdreq.stat.requestid = htons(kXR_stat);
1651  std::string s = resourceplusopaque.c_str();
1652 
1653 
1654  l = resourceplusopaque.length() + 1;
1655  xrdreq.stat.dlen = htonl(l);
1656 
1657  if (!prot->Bridge->Run((char *) &xrdreq, (char *) resourceplusopaque.c_str(), l)) {
1658  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1659  return -1;
1660  }
1661 
1662 
1663  if (depth == 0) {
1664  // We don't need to be invoked again
1665  return 1;
1666  } else
1667  // We need to be invoked again to complete the request
1668  return 0;
1669 
1670 
1671 
1672  break;
1673  }
1674 
1675  default: // Dirlist()
1676  {
1677 
1678  // --------- DIRLIST
1679  memset(&xrdreq, 0, sizeof (ClientRequest));
1681 
1682  std::string s = resourceplusopaque.c_str();
1684  //s += "?xrd.dirstat=1";
1685 
1686  l = s.length() + 1;
1687  xrdreq.dirlist.dlen = htonl(l);
1688 
1689  if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1690  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1691  return -1;
1692  }
1693 
1694  // We don't want to be invoked again after this request is finished
1695  return 1;
1696  }
1697  }
1698 
1699 
1700  break;
1701  }
1702  case XrdHttpReq::rtMKCOL:
1703  {
1704 
1705  // --------- MKDIR
1706  memset(&xrdreq, 0, sizeof (ClientRequest));
1707  xrdreq.mkdir.requestid = htons(kXR_mkdir);
1708 
1709  std::string s = resourceplusopaque.c_str();
1711 
1712  l = s.length() + 1;
1713  xrdreq.mkdir.dlen = htonl(l);
1714 
1715  if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1716  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1717  return -1;
1718  }
1719 
1720  // We don't want to be invoked again after this request is finished
1721  return 1;
1722  }
1723  case XrdHttpReq::rtMOVE:
1724  {
1725 
1726  // --------- MOVE
1727  memset(&xrdreq, 0, sizeof (ClientRequest));
1728  xrdreq.mv.requestid = htons(kXR_mv);
1729 
1730  std::string s = resourceplusopaque.c_str();
1731  s += " ";
1732 
1733  char buf[256];
1734  char *ppath;
1735  int port = 0;
1736  if (parseURL((char *) destination.c_str(), buf, port, &ppath)) {
1737  prot->SendSimpleResp(501, NULL, NULL, (char *) "Cannot parse destination url.", 0, false);
1738  return -1;
1739  }
1740 
1741  char buf2[256];
1742  strcpy(buf2, host.c_str());
1743  char *pos = strchr(buf2, ':');
1744  if (pos) *pos = '\0';
1745 
1746  // If we are a redirector we enforce that the host field is equal to
1747  // whatever was written in the destination url
1748  //
1749  // If we are a data server instead we cannot enforce anything, we will
1750  // just ignore the host part of the destination
1751  if ((prot->myRole == kXR_isManager) && strcmp(buf, buf2)) {
1752  prot->SendSimpleResp(501, NULL, NULL, (char *) "Only in-place renaming is supported for MOVE.", 0, false);
1753  return -1;
1754  }
1755 
1756 
1757 
1758 
1759  s += ppath;
1760 
1761  l = s.length() + 1;
1762  xrdreq.mv.dlen = htonl(l);
1764 
1765  if (!prot->Bridge->Run((char *) &xrdreq, (char *) s.c_str(), l)) {
1766  prot->SendSimpleResp(501, NULL, NULL, (char *) "Could not run request.", 0, false);
1767  return -1;
1768  }
1769 
1770  // We don't want to be invoked again after this request is finished
1771  return 1;
1772 
1773  }
1774  default:
1775  {
1776  prot->SendSimpleResp(501, NULL, NULL, (char *) "Request not supported.", 0, false);
1777  return -1;
1778  }
1779 
1780  }
1781 
1782  return 1;
1783 }
kXR_unt16 requestid
Definition: XProtocol.hh:479
kXR_char options[1]
Definition: XProtocol.hh:248
kXR_int16 arg1len
Definition: XProtocol.hh:430
#define kXR_isManager
Definition: XProtocol.hh:1156
kXR_unt16 requestid
Definition: XProtocol.hh:806
struct ClientCloseRequest close
Definition: XProtocol.hh:851
kXR_char fhandle[4]
Definition: XProtocol.hh:807
struct ClientMkdirRequest mkdir
Definition: XProtocol.hh:858
kXR_int32 dlen
Definition: XProtocol.hh:431
kXR_int64 offset
Definition: XProtocol.hh:646
kXR_unt16 requestid
Definition: XProtocol.hh:644
kXR_unt16 options
Definition: XProtocol.hh:481
struct ClientDirlistRequest dirlist
Definition: XProtocol.hh:852
kXR_unt16 requestid
Definition: XProtocol.hh:228
@ 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_new
Definition: XProtocol.hh:455
@ kXR_retstat
Definition: XProtocol.hh:463
struct ClientOpenRequest open
Definition: XProtocol.hh:860
@ kXR_dstat
Definition: XProtocol.hh:240
kXR_unt16 requestid
Definition: XProtocol.hh:428
kXR_char fhandle[4]
Definition: XProtocol.hh:645
kXR_char fhandle[4]
Definition: XProtocol.hh:229
@ 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_int32 dlen
Definition: XProtocol.hh:699
struct ClientRmRequest rm
Definition: XProtocol.hh:869
kXR_int32 dlen
Definition: XProtocol.hh:648
struct ClientReadRequest read
Definition: XProtocol.hh:867
struct ClientMvRequest mv
Definition: XProtocol.hh:859
kXR_unt16 requestid
Definition: XProtocol.hh:768
kXR_int32 dlen
Definition: XProtocol.hh:483
struct ClientRmdirRequest rmdir
Definition: XProtocol.hh:870
kXR_unt16 requestid
Definition: XProtocol.hh:415
kXR_unt16 mode
Definition: XProtocol.hh:480
kXR_char options[1]
Definition: XProtocol.hh:416
kXR_unt16 requestid
Definition: XProtocol.hh:697
@ kXR_mkdirpath
Definition: XProtocol.hh:410
struct ClientStatRequest stat
Definition: XProtocol.hh:873
kXR_int64 offset
Definition: XProtocol.hh:808
struct ClientWriteRequest write
Definition: XProtocol.hh:876
kXR_int32 dlen
Definition: XProtocol.hh:772
kXR_int32 rlen
Definition: XProtocol.hh:647
@ 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
Definition: XProtocol.hh:1221
kXR_unt16 requestid
Definition: XProtocol.hh:708
int kXR_int32
Definition: XPtypes.hh:89
unsigned char kXR_char
Definition: XPtypes.hh:65
#define DEBUG(x)
Definition: XrdBwmTrace.hh:54
int parseURL(char *url, char *host, int &port, char **path)
Definition: XrdHttpUtils.cc:77
std::vector< XrdOucIOVec2 > XrdHttpIOList
std::string obfuscateAuth(const std::string &input)
#define TRACE_DEBUG
Definition: XrdTrace.hh:36
#define TRACING(x)
Definition: XrdTrace.hh:70
#define TRACEI(act, x)
Definition: XrdTrace.hh:66
XrdHttpChecksumRawPtr getChecksumToRun(const std::string &userDigest) const
std::string getXRootDConfigDigestName() const
virtual int ProcessReq(XrdHttpExtReq &)=0
static kXR_int32 myRole
Our role.
XrdXrootd::Bridge * Bridge
The Bridge that we use to exercise the xrootd internals.
static char * staticredir
static XrdHttpChecksumHandler cksumHandler
int doChksum(const XrdOucString &fname)
Perform a checksum request.
static XrdOucHash< StaticPreloadInfo > * staticpreload
int doStat(char *fname)
Perform a Stat request.
static char * listredir
Url to redirect to in the case a listing is requested.
static bool listdeny
If true, any form of listing is denied.
static bool embeddedstatic
If true, use the embedded css and icons.
const XrdHttpIOList & NextReadList()
return XrdHttpIOList for sending to read or readv
bool isSingleRange()
indicates a single range (implied whole file, or single range) or empty file
int reqstate
State machine to talk to the bridge.
Definition: XrdHttpReq.hh:353
char fhandle[4]
Definition: XrdHttpReq.hh:346
int ReqReadV(const XrdHttpIOList &cl)
Prepare the buffers for sending a readv request.
Definition: XrdHttpReq.cc:393
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:94
std::vector< readahead_list > ralist
Definition: XrdHttpReq.hh:241
XrdOucString resource
The resource specified by the request, stripped of opaque data.
Definition: XrdHttpReq.hh:271
int ProcessHTTPReq()
Definition: XrdHttpReq.cc:936
long fileflags
Definition: XrdHttpReq.hh:343
XrdOucString resourceplusopaque
The resource specified by the request, including all the opaque data.
Definition: XrdHttpReq.hh:275
std::string host
The host field specified in the req.
Definition: XrdHttpReq.hh:295
XrdHttpChecksumHandler::XrdHttpChecksumRawPtr m_req_cksum
The checksum that was ran for this request.
Definition: XrdHttpReq.hh:303
bool m_appended_hdr2cgistr
Definition: XrdHttpReq.hh:314
void appendOpaque(XrdOucString &s, XrdSecEntity *secent, char *hash, time_t tnow)
Definition: XrdHttpReq.cc:635
bool m_appended_asize
Track whether we already appended the oss.asize argument for PUTs.
Definition: XrdHttpReq.hh:316
XrdOucString m_resource_with_digest
Definition: XrdHttpReq.hh:308
long long filesize
Definition: XrdHttpReq.hh:342
bool readClosing
Definition: XrdHttpReq.hh:283
void Put(const char *varname, const char *value)
Definition: XrdOucEnv.hh:85
const char * c_str() const
int erasefromend(int sz=0)
bool endswith(char c)
bool beginswith(char c)
int length() const
void append(const int i)
virtual int setSF(kXR_char *fhandle, bool seton=false)=0
virtual bool Run(const char *xreqP, char *xdataP=0, int xdataL=0)=0

References XrdOucString::append(), appendOpaque(), ClientMvRequest::arg1len, XrdOucString::beginswith(), XrdHttpProtocol::Bridge, XrdOucString::c_str(), XrdHttpProtocol::cksumHandler, ClientRequest::close, closeAfterError, XrdHttpProtocol::StaticPreloadInfo::data, DEBUG, depth, destination, ClientRequest::dirlist, ClientDirlistRequest::dlen, ClientMkdirRequest::dlen, ClientMvRequest::dlen, ClientOpenRequest::dlen, ClientReadRequest::dlen, ClientRmRequest::dlen, ClientRmdirRequest::dlen, ClientStatRequest::dlen, ClientWriteRequest::dlen, XrdHttpProtocol::doChksum(), XrdHttpProtocol::doStat(), XrdHttpProtocol::embeddedstatic, encode_opaque(), XrdOucString::endswith(), XrdOucString::erasefromend(), ClientCloseRequest::fhandle, ClientReadRequest::fhandle, ClientWriteRequest::fhandle, fhandle, fileflags, filesize, fopened, XrdHttpChecksumHandler::getChecksumToRun(), XrdHttpChecksum::getXRootDConfigDigestName(), hdr2cgistr, host, XrdHttpReadRangeHandler::isSingleRange(), 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_stat, kXR_ur, kXR_uw, kXR_write, XrdHttpProtocol::StaticPreloadInfo::len, length, XrdOucString::length(), XrdHttpProtocol::listdeny, XrdHttpProtocol::listredir, m_appended_asize, m_appended_hdr2cgistr, m_req_cksum, m_req_digest, m_resource_with_digest, ClientRequest::mkdir, ClientOpenRequest::mode, ClientRequest::mv, XrdHttpProtocol::myRole, XrdHttpReadRangeHandler::NextReadList(), obfuscateAuth(), ClientReadRequest::offset, ClientWriteRequest::offset, opaque, ClientRequest::open, ClientDirlistRequest::options, ClientMkdirRequest::options, ClientOpenRequest::options, parseBody(), parseURL(), XrdHttpExtHandler::ProcessReq(), XrdOucEnv::Put(), ralist, ClientRequest::read, readClosing, readRangeHandler, ReqReadV(), reqstate, request, ClientCloseRequest::requestid, ClientDirlistRequest::requestid, ClientMkdirRequest::requestid, ClientMvRequest::requestid, ClientOpenRequest::requestid, ClientReadRequest::requestid, ClientRmRequest::requestid, ClientRmdirRequest::requestid, ClientStatRequest::requestid, ClientWriteRequest::requestid, reset(), resource, resourceplusopaque, ClientReadRequest::rlen, ClientRequest::rm, ClientRequest::rmdir, rtDELETE, rtGET, rtHEAD, rtMalformed, rtMKCOL, rtMOVE, rtOPTIONS, rtPATCH, rtPROPFIND, rtPUT, rtUnknown, rtUnset, XrdXrootd::Bridge::Run(), sendcontinue, XrdXrootd::Bridge::setSF(), ClientRequest::stat, XrdHttpProtocol::staticpreload, XrdHttpProtocol::staticredir, TRACE, TRACE_DEBUG, TRACEI, TRACING, ClientRequest::write, writtenbytes, and xrdreq.

Referenced by XrdHttpProtocol::Process().

+ 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 541 of file XrdHttpReq.cc.

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

References appendOpaque(), XrdOucString::c_str(), calcHashes(), encode_opaque(), encode_str(), XrdHttpProtocol::isdesthttps, keepalive, obfuscateAuth(), redirdest, request, reset(), resource, rtGET, XrdHttpProtocol::SecEntity, XrdHttpProtocol::secretkey, 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 393 of file XrdHttpReq.cc.

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

References ClientReadVRequest::dlen, ClientRequest::header, kXR_readv, ralist, ClientRequest::readv, ClientRequestHdr::requestid, 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 2813 of file XrdHttpReq.cc.

2813  {
2814 
2815  TRACE(REQ, " XrdHttpReq request ended.");
2816 
2817  //if (xmlbody) xmlFreeDoc(xmlbody);
2819  readClosing = false;
2820  closeAfterError = false;
2821  writtenbytes = 0;
2822  etext.clear();
2823  redirdest = "";
2824 
2825  // // Here we should deallocate this
2826  // const struct iovec *iovP //!< pointer to data array
2827  // int iovN, //!< array count
2828  // int iovL, //!< byte count
2829  // bool final //!< true -> final result
2830 
2831 
2832  //xmlbody = 0;
2833  depth = 0;
2836  ralist.clear();
2837  ralist.shrink_to_fit();
2838 
2839  request = rtUnset;
2840  resource = "";
2841  allheaders.clear();
2842 
2843  // Reset the state of the request's digest request.
2844  m_req_digest.clear();
2845  m_digest_header.clear();
2846  m_req_cksum = nullptr;
2847 
2849  m_user_agent = "";
2850 
2851  headerok = false;
2852  keepalive = true;
2853  length = 0;
2854  filesize = 0;
2855  depth = 0;
2856  sendcontinue = false;
2857 
2858  m_transfer_encoding_chunked = false;
2859  m_current_chunk_size = -1;
2860  m_current_chunk_offset = 0;
2861 
2862  m_trailer_headers = false;
2863  m_status_trailer = false;
2864 
2866  reqstate = 0;
2867 
2868  memset(&xrdreq, 0, sizeof (xrdreq));
2869  memset(&xrdresp, 0, sizeof (xrdresp));
2871 
2872  etext.clear();
2873  redirdest = "";
2874 
2875  stringresp = "";
2876 
2877  host = "";
2878  destination = "";
2879  hdr2cgistr = "";
2880  m_appended_hdr2cgistr = false;
2881  m_appended_asize = false;
2882 
2883  iovP = 0;
2884  iovN = 0;
2885  iovL = 0;
2886 
2887 
2888  if (opaque) delete(opaque);
2889  opaque = 0;
2890 
2891  fopened = false;
2892 
2893  final = false;
2894 
2895  mScitag = -1;
2896 }
@ kXR_noErrorYet
Definition: XProtocol.hh:1027
@ kXR_noResponsesYet
Definition: XProtocol.hh:908
void reset()
resets this handler
std::string m_digest_header
The computed digest for the HTTP response header.
Definition: XrdHttpReq.hh:310
std::string stringresp
If we want to give a string as a response, we compose it here.
Definition: XrdHttpReq.hh:350

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_req_cksum, m_req_digest, m_resource_with_digest, mScitag, opaque, ralist, readClosing, readRangeHandler, redirdest, reqstate, request, XrdHttpReadRangeHandler::reset(), resource, rtUnset, sendcontinue, stringresp, TRACE, writtenbytes, xrderrcode, xrdreq, and xrdresp.

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

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

◆ setTransferStatusHeader()

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

Definition at line 2114 of file XrdHttpReq.cc.

2114  {
2115  if (m_status_trailer) {
2116  if (header.empty()) {
2117  header += "Trailer: X-Transfer-Status";
2118  } else {
2119  header += "\r\nTrailer: X-Transfer-Status";
2120  }
2121  }
2122 }

◆ userAgent()

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

Definition at line 259 of file XrdHttpReq.hh.

259 {return m_user_agent;}

Referenced by XrdHttpProtocol::Process().

+ Here is the caller graph for this function:

Member Data Documentation

◆ allheaders

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

Definition at line 268 of file XrdHttpReq.hh.

Referenced by parseLine(), and reset().

◆ closeAfterError

bool XrdHttpReq::closeAfterError

Definition at line 287 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ depth

int XrdHttpReq::depth

Definition at line 291 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 297 of file XrdHttpReq.hh.

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

◆ etext

std::string XrdHttpReq::etext

Definition at line 332 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ fhandle

char XrdHttpReq::fhandle[4]

Definition at line 346 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq().

◆ filectime

long XrdHttpReq::filectime

Definition at line 345 of file XrdHttpReq.hh.

◆ fileflags

long XrdHttpReq::fileflags

Definition at line 343 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::doStat(), and ProcessHTTPReq().

◆ filemodtime

long XrdHttpReq::filemodtime

Definition at line 344 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::doStat().

◆ filesize

long long XrdHttpReq::filesize

Definition at line 342 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::doStat(), ProcessHTTPReq(), and reset().

◆ final

bool XrdHttpReq::final

true -> final result

Definition at line 339 of file XrdHttpReq.hh.

◆ fopened

bool XrdHttpReq::fopened

Definition at line 347 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 313 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 279 of file XrdHttpReq.hh.

Referenced by XrdHttpReq(), XrdHttpProtocol::Process(), and reset().

◆ host

std::string XrdHttpReq::host

The host field specified in the req.

Definition at line 295 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ iovL

int XrdHttpReq::iovL

byte count

Definition at line 338 of file XrdHttpReq.hh.

Referenced by Data(), and reset().

◆ iovN

int XrdHttpReq::iovN

array count

Definition at line 337 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 336 of file XrdHttpReq.hh.

Referenced by Data(), and reset().

◆ keepalive

bool XrdHttpReq::keepalive

Definition at line 289 of file XrdHttpReq.hh.

Referenced by 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 316 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ m_appended_hdr2cgistr

bool XrdHttpReq::m_appended_hdr2cgistr

Definition at line 314 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 310 of file XrdHttpReq.hh.

Referenced by reset().

◆ m_req_cksum

XrdHttpChecksumHandler::XrdHttpChecksumRawPtr XrdHttpReq::m_req_cksum = nullptr

The checksum that was ran for this request.

Definition at line 303 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 300 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 308 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ mScitag

int XrdHttpReq::mScitag

Definition at line 358 of file XrdHttpReq.hh.

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

◆ opaque

XrdOucEnv* XrdHttpReq::opaque

The opaque data, after parsing.

Definition at line 273 of file XrdHttpReq.hh.

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

◆ ralist

std::vector<readahead_list> XrdHttpReq::ralist

Definition at line 241 of file XrdHttpReq.hh.

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

◆ readClosing

bool XrdHttpReq::readClosing

Definition at line 283 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 282 of file XrdHttpReq.hh.

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

◆ redirdest

XrdOucString XrdHttpReq::redirdest

Definition at line 333 of file XrdHttpReq.hh.

Referenced by Redir(), and reset().

◆ reqstate

int XrdHttpReq::reqstate

State machine to talk to the bridge.

Definition at line 353 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::Process(), ProcessHTTPReq(), and reset().

◆ request

ReqType XrdHttpReq::request

The request we got.

Definition at line 263 of file XrdHttpReq.hh.

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

◆ requestverb

std::string XrdHttpReq::requestverb

Definition at line 264 of file XrdHttpReq.hh.

Referenced by parseFirstLine().

◆ resource

XrdOucString XrdHttpReq::resource

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

Definition at line 271 of file XrdHttpReq.hh.

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

◆ resourceplusopaque

XrdOucString XrdHttpReq::resourceplusopaque

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

Definition at line 275 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 324 of file XrdHttpReq.hh.

◆ rwOpPartialDone

unsigned int XrdHttpReq::rwOpPartialDone

Definition at line 324 of file XrdHttpReq.hh.

◆ sendcontinue

bool XrdHttpReq::sendcontinue

Definition at line 292 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 350 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 356 of file XrdHttpReq.hh.

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

◆ xrderrcode

XErrorCode XrdHttpReq::xrderrcode

Definition at line 331 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ xrdreq

ClientRequest XrdHttpReq::xrdreq

The last issued xrd request, often pending.

Definition at line 327 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::doChksum(), XrdHttpProtocol::doStat(), Error(), XrdHttpProtocol::Process(), ProcessHTTPReq(), ReqReadV(), and reset().

◆ xrdresp

XResponseType XrdHttpReq::xrdresp

The last response data we got.

Definition at line 330 of file XrdHttpReq.hh.

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


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