XRootD
XrdHttpReq Class Reference

#include <XrdHttpReq.hh>

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

Public Types

enum  ReqType {
  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 ()
 
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
 
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

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 221 of file XrdHttpReq.hh.

221  {
222  rtUnset = -1,
223  rtUnknown = 0,
224  rtMalformed,
225  rtGET,
226  rtHEAD,
227  rtPUT,
228  rtOPTIONS,
229  rtPATCH,
230  rtDELETE,
231  rtPROPFIND,
232  rtMKCOL,
233  rtMOVE,
234  rtPOST
235  };

Constructor & Destructor Documentation

◆ XrdHttpReq()

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

Definition at line 168 of file XrdHttpReq.hh.

168  :
169  readRangeHandler(rcfg), keepalive(true) {
170 
171  prot = protinstance;
172  length = 0;
173  //xmlbody = 0;
174  depth = 0;
175  opaque = 0;
176  writtenbytes = 0;
177  fopened = false;
178  headerok = false;
179  mScitag = -1;
180  };
bool keepalive
Definition: XrdHttpReq.hh:260
long long length
Definition: XrdHttpReq.hh:261
bool headerok
Tells if we have finished reading the header.
Definition: XrdHttpReq.hh:254
long long writtenbytes
In a long write, we track where we have arrived.
Definition: XrdHttpReq.hh:327
XrdOucEnv * opaque
The opaque data, after parsing.
Definition: XrdHttpReq.hh:248
bool fopened
Definition: XrdHttpReq.hh:318
XrdHttpReadRangeHandler readRangeHandler
Tracking the next ranges of data to read during GET.
Definition: XrdHttpReq.hh:257

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:2781

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

791  {
792  if (hdr2cgistr.length() > 0) {
793  hdr2cgistr.append("&");
794  }
795  hdr2cgistr.append(key);
796  hdr2cgistr.append("=");
797  hdr2cgistr.append(value);
798 }
std::string hdr2cgistr
Additional opaque info that may come from the hdr2cgi directive.
Definition: XrdHttpReq.hh:284

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

634  {
635 
636  int l = 0;
637  char * p = 0;
638  if (opaque)
639  p = opaque->Env(l);
640 
641  if (hdr2cgistr.empty() && (l < 2) && !hash) return;
642 
643  // this works in most cases, except if the url already contains the xrdhttp tokens
644  s = s + "?";
645  if (!hdr2cgistr.empty()) {
646  char *s1 = quote(hdr2cgistr.c_str());
647  if (s1) {
648  s += s1;
649  free(s1);
650  }
651  }
652  if (p && (l > 1)) {
653  char *s1 = quote(p+1);
654  if (s1) {
655  if (!hdr2cgistr.empty()) {
656  s = s + "&";
657  }
658  s = s + s1;
659  free(s1);
660  }
661  }
662 
663 
664 
665  if (hash) {
666  if (l > 1) s += "&";
667  s += "xrdhttptk=";
668  s += hash;
669 
670  s += "&xrdhttptime=";
671  char buf[256];
672  sprintf(buf, "%lld", (long long) tnow);
673  s += buf;
674 
675  if (secent) {
676  if (secent->name) {
677  s += "&xrdhttpname=";
678  char *s1 = quote(secent->name);
679  if (s1) {
680  s += s1;
681  free(s1);
682  }
683  }
684 
685  if (secent->vorg) {
686  s += "&xrdhttpvorg=";
687  char *s1 = quote(secent->vorg);
688  if (s1) {
689  s += s1;
690  free(s1);
691  }
692  }
693 
694  if (secent->host) {
695  s += "&xrdhttphost=";
696  char *s1 = quote(secent->host);
697  if (s1) {
698  s += s1;
699  free(s1);
700  }
701  }
702 
703  if (secent->moninfo) {
704  s += "&xrdhttpdn=";
705  char *s1 = quote(secent->moninfo);
706  if (s1) {
707  s += s1;
708  free(s1);
709  }
710  }
711 
712  if (secent->role) {
713  s += "&xrdhttprole=";
714  char *s1 = quote(secent->role);
715  if (s1) {
716  s += s1;
717  free(s1);
718  }
719  }
720 
721  if (secent->grps) {
722  s += "&xrdhttpgrps=";
723  char *s1 = quote(secent->grps);
724  if (s1) {
725  s += s1;
726  free(s1);
727  }
728  }
729 
730  if (secent->endorsements) {
731  s += "&xrdhttpendorsements=";
732  char *s1 = quote(secent->endorsements);
733  if (s1) {
734  s += s1;
735  free(s1);
736  }
737  }
738 
739  if (secent->credslen) {
740  s += "&xrdhttpcredslen=";
741  char buf[16];
742  sprintf(buf, "%d", secent->credslen);
743  char *s1 = quote(buf);
744  if (s1) {
745  s += s1;
746  free(s1);
747  }
748  }
749 
750  if (secent->credslen) {
751  if (secent->creds) {
752  s += "&xrdhttpcreds=";
753  // Apparently this string might be not 0-terminated (!)
754  char *zerocreds = strndup(secent->creds, secent->credslen);
755  if (zerocreds) {
756  char *s1 = quote(zerocreds);
757  if (s1) {
758  s += s1;
759  free(s1);
760  }
761  free(zerocreds);
762  }
763  }
764  }
765 
766  }
767  }
768 
769 }
char * quote(const char *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, XrdSecEntity::endorsements, XrdOucEnv::Env(), XrdSecEntity::grps, hdr2cgistr, XrdSecEntity::host, XrdSecEntity::moninfo, XrdSecEntity::name, opaque, quote(), 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:301
int iovL
byte count
Definition: XrdHttpReq.hh:309
const struct iovec * iovP
The latest data chunks got from the xrd layer. These are valid only inside the callbacks!
Definition: XrdHttpReq.hh:307
int iovN
array count
Definition: XrdHttpReq.hh:308

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  if (PostProcessHTTPReq()) reset();
528 
529  // If we are servicing a GET on a directory, it'll generate an error for the default
530  // OSS (we don't assume this is always true). Catch and suppress the error so we can instead
531  // generate a directory listing (if configured).
532  if ((request == rtGET) && (xrdreq.header.requestid == ntohs(kXR_open)) && (xrderrcode == kXR_isDirectory))
533  return true;
534 
535  return false;
536 };
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:303
ReqType request
The request we got.
Definition: XrdHttpReq.hh:238
XErrorCode xrderrcode
Definition: XrdHttpReq.hh:302
ClientRequest xrdreq
The last issued xrd request, often pending.
Definition: XrdHttpReq.hh:298

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:239

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

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

References appendOpaque(), XrdOucString::c_str(), calcHashes(), XrdHttpProtocol::isdesthttps, keepalive, obfuscateAuth(), quote(), 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 2781 of file XrdHttpReq.cc.

2781  {
2782 
2783  TRACE(REQ, " XrdHttpReq request ended.");
2784 
2785  //if (xmlbody) xmlFreeDoc(xmlbody);
2787  readClosing = false;
2788  writtenbytes = 0;
2789  etext.clear();
2790  redirdest = "";
2791 
2792  // // Here we should deallocate this
2793  // const struct iovec *iovP //!< pointer to data array
2794  // int iovN, //!< array count
2795  // int iovL, //!< byte count
2796  // bool final //!< true -> final result
2797 
2798 
2799  //xmlbody = 0;
2800  depth = 0;
2803  ralist.clear();
2804  ralist.shrink_to_fit();
2805 
2806  request = rtUnset;
2807  resource = "";
2808  allheaders.clear();
2809 
2810  // Reset the state of the request's digest request.
2811  m_req_digest.clear();
2812  m_digest_header.clear();
2813  m_req_cksum = nullptr;
2814 
2816  m_user_agent = "";
2817 
2818  headerok = false;
2819  keepalive = true;
2820  length = 0;
2821  filesize = 0;
2822  depth = 0;
2823  sendcontinue = false;
2824 
2825  m_transfer_encoding_chunked = false;
2826  m_current_chunk_size = -1;
2827  m_current_chunk_offset = 0;
2828 
2829  m_trailer_headers = false;
2830  m_status_trailer = false;
2831 
2833  reqstate = 0;
2834 
2835  memset(&xrdreq, 0, sizeof (xrdreq));
2836  memset(&xrdresp, 0, sizeof (xrdresp));
2838 
2839  etext.clear();
2840  redirdest = "";
2841 
2842  stringresp = "";
2843 
2844  host = "";
2845  destination = "";
2846  hdr2cgistr = "";
2847  m_appended_hdr2cgistr = false;
2848  m_appended_asize = false;
2849 
2850  iovP = 0;
2851  iovN = 0;
2852  iovL = 0;
2853 
2854 
2855  if (opaque) delete(opaque);
2856  opaque = 0;
2857 
2858  fopened = false;
2859 
2860  final = false;
2861 
2862  mScitag = -1;
2863 }
@ 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:281
std::string stringresp
If we want to give a string as a response, we compose it here.
Definition: XrdHttpReq.hh:321

References allheaders, 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:

◆ userAgent()

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

Definition at line 212 of file XrdHttpReq.hh.

212 {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 243 of file XrdHttpReq.hh.

Referenced by parseLine(), and reset().

◆ depth

int XrdHttpReq::depth

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

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

◆ etext

std::string XrdHttpReq::etext

Definition at line 303 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ fhandle

char XrdHttpReq::fhandle[4]

Definition at line 317 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq().

◆ filectime

long XrdHttpReq::filectime

Definition at line 316 of file XrdHttpReq.hh.

◆ fileflags

long XrdHttpReq::fileflags

Definition at line 314 of file XrdHttpReq.hh.

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

◆ filemodtime

long XrdHttpReq::filemodtime

Definition at line 315 of file XrdHttpReq.hh.

Referenced by XrdHttpProtocol::doStat().

◆ filesize

long long XrdHttpReq::filesize

Definition at line 313 of file XrdHttpReq.hh.

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

◆ final

bool XrdHttpReq::final

true -> final result

Definition at line 310 of file XrdHttpReq.hh.

◆ fopened

bool XrdHttpReq::fopened

Definition at line 318 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 284 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 254 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 266 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ iovL

int XrdHttpReq::iovL

byte count

Definition at line 309 of file XrdHttpReq.hh.

Referenced by Data(), and reset().

◆ iovN

int XrdHttpReq::iovN

array count

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

Referenced by Data(), and reset().

◆ keepalive

bool XrdHttpReq::keepalive

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

Referenced by ProcessHTTPReq(), and reset().

◆ m_appended_hdr2cgistr

bool XrdHttpReq::m_appended_hdr2cgistr

Definition at line 285 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 281 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 274 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 271 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 279 of file XrdHttpReq.hh.

Referenced by ProcessHTTPReq(), and reset().

◆ mScitag

int XrdHttpReq::mScitag

Definition at line 329 of file XrdHttpReq.hh.

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

◆ opaque

XrdOucEnv* XrdHttpReq::opaque

The opaque data, after parsing.

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

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

◆ readClosing

bool XrdHttpReq::readClosing

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

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

◆ redirdest

XrdOucString XrdHttpReq::redirdest

Definition at line 304 of file XrdHttpReq.hh.

Referenced by Redir(), and reset().

◆ reqstate

int XrdHttpReq::reqstate

State machine to talk to the bridge.

Definition at line 324 of file XrdHttpReq.hh.

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

◆ request

ReqType XrdHttpReq::request

The request we got.

Definition at line 238 of file XrdHttpReq.hh.

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

◆ requestverb

std::string XrdHttpReq::requestverb

Definition at line 239 of file XrdHttpReq.hh.

Referenced by parseFirstLine().

◆ resource

XrdOucString XrdHttpReq::resource

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

Definition at line 246 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 250 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 295 of file XrdHttpReq.hh.

◆ rwOpPartialDone

unsigned int XrdHttpReq::rwOpPartialDone

Definition at line 295 of file XrdHttpReq.hh.

◆ sendcontinue

bool XrdHttpReq::sendcontinue

Definition at line 263 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 321 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 327 of file XrdHttpReq.hh.

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

◆ xrderrcode

XErrorCode XrdHttpReq::xrderrcode

Definition at line 302 of file XrdHttpReq.hh.

Referenced by Error(), and reset().

◆ xrdreq

ClientRequest XrdHttpReq::xrdreq

The last issued xrd request, often pending.

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

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


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