#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlListdirOp:

Collaboration diagram for XrdClHttp::CurlListdirOp:

Public Member Functions
	CurlListdirOp (XrdCl::ResponseHandler handler, const std::string &url, const std::string &host_addr, bool response_info, struct timespec timeout, XrdCl::Log logger, CreateConnCalloutType callout, HeaderCallout *header_callout)

virtual	~CurlListdirOp ()

virtual HttpVerb	GetVerb () const override

void	ReleaseHandle () override

bool	Setup (CURL *curl, CurlWorker &) override

void	Success () override

Public Member Functions inherited from XrdClHttp::CurlOperation
	CurlOperation (const CurlOperation &)=delete

	CurlOperation (XrdCl::ResponseHandler handler, const std::string &url, std::chrono::steady_clock::time_point expiry, XrdCl::Log log, CreateConnCalloutType, HeaderCallout *header_callout)

	CurlOperation (XrdCl::ResponseHandler handler, const std::string &url, struct timespec timeout, XrdCl::Log log, CreateConnCalloutType, HeaderCallout *header_callout)

virtual	~CurlOperation ()

virtual bool	ContinueHandle ()

virtual void	Fail (uint16_t errCode, uint32_t errNum, const std::string &)

bool	FinishSetup (CURL *curl)

std::pair< XErrorCode, std::string >	GetCallbackError () const

CreateConnCalloutType	GetConnCalloutFunc () const

std::string	GetCurlErrorMessage () const

CURL *	GetCurlHandle () const

OpError	GetError () const

std::chrono::steady_clock::time_point	GetHeaderExpiry () const

std::chrono::steady_clock::time_point	GetOperationExpiry ()

std::unique_ptr< ResponseInfo >	GetResponseInfo ()

int	GetStatusCode () const

std::string	GetStatusMessage () const

bool	GetTriedBoker () const

const std::string &	GetUrl () const

bool	HasFailed () const

bool	HeaderTimeoutExpired (const std::chrono::steady_clock::time_point &now)

bool	IsDone () const

bool	IsPaused () const

bool	IsRedirect () const

std::unique_ptr< ResponseInfo >	MoveResponseInfo ()

bool	OperationTimeoutExpired (const std::chrono::steady_clock::time_point &now)

virtual void	OptionsDone ()

virtual RedirectAction	Redirect (std::string &target)

virtual bool	RequiresOptions () const

virtual void	SetContinueQueue (std::shared_ptr< XrdClHttp::HandlerQueue > queue)

void	SetTriedBoker ()

bool	StartConnectionCallout (std::string &err)

std::tuple< uint64_t, std::chrono::steady_clock::duration, std::chrono::steady_clock::duration, std::chrono::steady_clock::duration >	StatisticsReset ()

bool	TransferStalled (uint64_t xfer_bytes, const std::chrono::steady_clock::time_point &now)

bool	UseConnectionCallout ()

virtual int	WaitSocket ()

virtual int	WaitSocketCallback (std::string &err)

Additional Inherited Members
Public Types inherited from XrdClHttp::CurlOperation
using	HeaderList = std::vector< std::pair< std::string, std::string > >

enum class	HttpVerb { COPY , DELETE , HEAD , GET , MKCOL , OPTIONS , PROPFIND , PUT , Count }

enum	OpError { ErrNone , ErrHeaderTimeout , ErrCallback , ErrOperationTimeout , ErrTransferClientStall , ErrTransferStall , ErrTransferSlow }

enum class	RedirectAction { Fail , Reinvoke , ReinvokeAfterAllow }

Static Public Member Functions inherited from XrdClHttp::CurlOperation
static void	CleanupDnsCache ()

static int	GetDefaultSlowRateBytesSec ()

static int	GetDefaultStallTimeout ()

static const std::string	GetVerbString (HttpVerb)

static void	SetSlowRateBytesSec (int rate)

static void	SetStallTimeout (const std::chrono::steady_clock::duration &stall_interval)

static void	SetStallTimeout (int stall_interval)

Protected Member Functions inherited from XrdClHttp::CurlOperation
int	FailCallback (XErrorCode ecode, const std::string &emsg)

void	SetDone (bool has_failed)

void	SetPaused (bool paused)

void	UpdateBytes (uint64_t bytes)

Protected Attributes inherited from XrdClHttp::CurlOperation
std::unique_ptr< CURL, void()(CURL )>	m_curl

XrdCl::ResponseHandler *	m_handler {nullptr}

HeaderCallout *	m_header_callout

std::chrono::steady_clock::time_point	m_header_expiry

HeaderParser	m_headers

std::vector< std::pair< std::string, std::string > >	m_headers_list

XrdCl::Log *	m_logger

int	m_minimum_rate {m_minimum_transfer_rate}

std::chrono::steady_clock::time_point	m_operation_expiry

const std::string	m_url

Static Protected Attributes inherited from XrdClHttp::CurlOperation
static constexpr int	m_default_minimum_rate {1024 * 256}

static int	m_minimum_transfer_rate {CurlOperation::m_default_minimum_rate}

Detailed Description

Definition at line 763 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

◆ CurlListdirOp()

CurlListdirOp::CurlListdirOp	(	XrdCl::ResponseHandler *	handler,
		const std::string &	url,
		const std::string &	host_addr,
		bool	response_info,
		struct timespec	timeout,
		XrdCl::Log *	logger,
		CreateConnCalloutType	callout,
		HeaderCallout *	header_callout
	)

Definition at line 32 of file XrdClHttpOpListdir.cc.

                                    :
     CurlOperation(handler, url, timeout, logger, callout, header_callout),
     m_response_info(set_response_info),
     m_host_addr(host_addr)
 {
     m_minimum_rate = 1024.0 * 1;
 }

References XrdClHttp::CurlOperation::m_minimum_rate.

◆ ~CurlListdirOp()

virtual XrdClHttp::CurlListdirOp::~CurlListdirOp ( )

inlinevirtual

Definition at line 768 of file XrdClHttpOps.hh.

768 {}

Member Function Documentation

◆ GetVerb()

virtual HttpVerb XrdClHttp::CurlListdirOp::GetVerb ( ) const

inlineoverridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 774 of file XrdClHttpOps.hh.

774 {return HttpVerb::PROPFIND;}

◆ ReleaseHandle()

void CurlListdirOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 55 of file XrdClHttpOpListdir.cc.

 {
     if (m_curl == nullptr) return;
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_HTTPHEADER, nullptr);
     CurlOperation::ReleaseHandle();
 }

References XrdClHttp::CurlOperation::m_curl, and XrdClHttp::CurlOperation::ReleaseHandle().

Here is the call graph for this function:

◆ Setup()

bool CurlListdirOp::Setup	(	CURL *	curl,
		CurlWorker &	worker
	)

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 43 of file XrdClHttpOpListdir.cc.

 {
     if (!CurlOperation::Setup(curl, worker)) return false;
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, CurlListdirOp::WriteCallback);
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, this);
     curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, "PROPFIND");
     m_headers_list.emplace_back("Depth", "1");
  
     return true;
 }

References XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers_list, and XrdClHttp::CurlOperation::Setup().

Here is the call graph for this function:

◆ Success()

void CurlListdirOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 168 of file XrdClHttpOpListdir.cc.

 {
     SetDone(false);
     m_logger->Debug(kLogXrdClHttp, "CurlListdirOp::Success");
  
     std::unique_ptr<XrdCl::DirectoryList> dirlist(m_response_info ? new DirectoryListResponse() : new XrdCl::DirectoryList());
  
     TiXmlDocument doc;
     doc.Parse(m_response.c_str());
     if (doc.Error()) {
         m_logger->Error(kLogXrdClHttp, "Failed to parse XML response: %s", m_response.substr(0, 1024).c_str());
         Fail(XrdCl::errErrorResponse, kXR_FSError, "Server responded to directory listing with invalid XML");
         return;
     }
  
     auto elem = doc.RootElement();
     if (strcasecmp(elem->Value(), "D:multistatus")) {
         m_logger->Error(kLogXrdClHttp, "Unexpected XML response: %s", m_response.substr(0, 1024).c_str());
         Fail(XrdCl::errErrorResponse, kXR_FSError, "Server responded to directory listing unexpected XML root");
         return;
     }
     bool skip = true;
     for (auto response = elem->FirstChildElement(); response != nullptr; response = response->NextSiblingElement()) {
         if (strcasecmp(response->Value(), "D:response")) {
             continue;
         }
  
         auto [entry, success] = ParseResponse(response);
         if (!success) {
             m_logger->Error(kLogXrdClHttp, "Failed to parse response element in XML response: %s", m_response.substr(0, 1024).c_str());
             Fail(XrdCl::errErrorResponse, kXR_FSError, "Server responded with invalid directory listing");
             return;
         }
         // Skip the first entry in the response, which is the directory itself
         if (skip) {
             skip = false;
         } else {
             uint32_t flags = XrdCl::StatInfo::Flags::IsReadable;
             if (entry.m_isdir) {
                 flags |= XrdCl::StatInfo::Flags::IsDir;
             }
             if (entry.m_isexec) {
                 flags |= XrdCl::StatInfo::Flags::XBitSet;
             }
             dirlist->Add(new XrdCl::DirectoryList::ListEntry(m_host_addr, entry.m_name, new XrdCl::StatInfo("nobody", entry.m_size, flags, entry.m_lastmodified)));
         }
     }
  
     m_logger->Debug(kLogXrdClHttp, "Successful propfind directory listing operation on %s (%u items)", m_url.c_str(), static_cast<unsigned>(dirlist->GetSize()));
     if (m_handler == nullptr) {return;}
  
     if (m_response_info) {
         static_cast<DirectoryListResponse*>(dirlist.get())->SetResponseInfo(MoveResponseInfo());
     }
     auto obj = new XrdCl::AnyObject();
     obj->Set(dirlist.release());
  
     auto handle = m_handler;
     m_handler = nullptr;
     handle->HandleResponse(new XrdCl::XRootDStatus(), obj);
 }

References XrdCl::Log::Debug(), XrdCl::errErrorResponse, XrdCl::Log::Error(), XrdClHttp::CurlOperation::Fail(), XrdCl::ResponseHandler::HandleResponse(), XrdClHttp::kLogXrdClHttp, kXR_FSError, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, XrdClHttp::CurlOperation::m_url, XrdClHttp::CurlOperation::MoveResponseInfo(), and XrdClHttp::CurlOperation::SetDone().

Here is the call graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CurlListdirOp()

◆ ~CurlListdirOp()

Member Function Documentation

◆ GetVerb()

◆ ReleaseHandle()

◆ Setup()

◆ Success()