XrdClHttp::CurlStatOp Class Reference

#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlStatOp:

Collaboration diagram for XrdClHttp::CurlStatOp:

Public Member Functions
	CurlStatOp (XrdCl::ResponseHandler *handler, const std::string &url, struct timespec timeout, XrdCl::Log *log, bool response_info, CreateConnCalloutType callout, HeaderCallout *header_callout)
virtual	~CurlStatOp ()
std::pair< int64_t, bool >	GetStatInfo ()
virtual HttpVerb	GetVerb () const override
virtual void	OptionsDone () override
RedirectAction	Redirect (std::string &target) override
void	ReleaseHandle () override
virtual bool	RequiresOptions () const 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	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)

Protected Member Functions
void	SuccessImpl (bool returnObj)
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)

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 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 445 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

CurlStatOp()

XrdClHttp::CurlStatOp::CurlStatOp ( XrdCl::ResponseHandler *  handler, const std::string &  url, struct timespec  timeout, XrdCl::Log *  log, bool  response_info, CreateConnCalloutType  callout, HeaderCallout *  header_callout  )

inline

Definition at line 447 of file XrdClHttpOps.hh.

                                                                                                         :
    CurlOperation(handler, url, timeout, log, callout, header_callout),
    m_response_info(response_info)
    {
        m_operation_expiry = m_header_expiry;
    }

References XrdClHttp::CurlOperation::m_header_expiry, and XrdClHttp::CurlOperation::m_operation_expiry.

~CurlStatOp()

virtual XrdClHttp::CurlStatOp::~CurlStatOp ( )

inlinevirtual

Definition at line 455 of file XrdClHttpOps.hh.

{}

Member Function Documentation

GetStatInfo()

std::pair< int64_t, bool > CurlStatOp::GetStatInfo

(

)

Definition at line 148 of file XrdClHttpOpStat.cc.

                        {
    if (!m_is_propfind) {
        m_length = m_headers.GetContentLength();
        return {m_length, false};
    }
    if (m_length >= 0) {
        return {m_length, m_is_dir};
    }
 
    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());
        return {-1, false};
    }
 
    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());
        return {-1, false};
    }
    auto found_response = false;
    for (auto response = elem->FirstChildElement(); response != nullptr; response = response->NextSiblingElement()) {
        if (!strcasecmp(response->Value(), "D:response")) {
            found_response = true;
            elem = response;
            break;
        }
    }
    if (!found_response) {
        m_logger->Error(kLogXrdClHttp, "Failed to find response element in XML response: %s", m_response.substr(0, 1024).c_str());
        return {-1, false};
    }
    for (auto child = elem->FirstChildElement(); child != nullptr; child = child->NextSiblingElement()) {
                if (strcasecmp(child->Value(), "D:propstat")) {
            continue;
        }
        for (auto prop = child->FirstChildElement(); prop != nullptr; prop = prop->NextSiblingElement()) {
            if (!strcasecmp(prop->Value(), "D:prop")) {
                return ParseProp(prop);
            }
        }
        }
    m_logger->Error(kLogXrdClHttp, "Failed to find properties in XML response: %s", m_response.substr(0, 1024).c_str());
    return {-1, false};
}

References child(), XrdCl::Log::Error(), XrdClHttp::HeaderParser::GetContentLength(), XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_headers, and XrdClHttp::CurlOperation::m_logger.

Referenced by XrdClHttp::CurlOpenOp::Success(), and SuccessImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVerb()

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

inlineoverridevirtual

Implements XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlChecksumOp.

Definition at line 467 of file XrdClHttpOps.hh.

{return m_is_propfind ? HttpVerb::PROPFIND : HttpVerb::HEAD;}

OptionsDone()

void CurlStatOp::OptionsDone ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlChecksumOp.

Definition at line 34 of file XrdClHttpOpStat.cc.

{
    auto &instance = VerbsCache::Instance();
    auto target = m_headers.GetLocation();
    auto verbs = instance.Get(target.empty() ? m_url : target);
    if (verbs.IsSet(VerbsCache::HttpVerb::kPROPFIND)) {
        curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, "PROPFIND");
        m_headers_list.emplace_back("Depth", "0");
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 0L);
        m_is_propfind = true;
    } else {
        m_is_propfind = false;
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 1L);
    }
}

References XrdClHttp::HeaderParser::GetLocation(), XrdClHttp::VerbsCache::Instance(), XrdClHttp::VerbsCache::kPROPFIND, XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers, XrdClHttp::CurlOperation::m_headers_list, and XrdClHttp::CurlOperation::m_url.

Here is the call graph for this function:

Redirect()

CurlOperation::RedirectAction CurlStatOp::Redirect ( std::string &  target )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlChecksumOp.

Definition at line 51 of file XrdClHttpOpStat.cc.

{
    auto headers = m_headers;
    auto result = CurlOperation::Redirect(target);
    if (result == CurlOperation::RedirectAction::Fail) {
        return result;
    }
    auto &instance = VerbsCache::Instance();
    auto verbs = instance.Get(target);
    if (verbs.IsSet(VerbsCache::HttpVerb::kUnset)) {
        m_headers = std::move(headers);
        return CurlOperation::RedirectAction::ReinvokeAfterAllow;
    }
 
    if (verbs.IsSet(VerbsCache::HttpVerb::kPROPFIND)) {
        curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, "PROPFIND");
        m_headers_list.emplace_back("Depth", "0");
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 0L);
        m_is_propfind = true;
    } else {
        m_is_propfind = false;
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 1L);
    }
    return CurlOperation::RedirectAction::Reinvoke;
}

References XrdClHttp::VerbsCache::Instance(), XrdClHttp::VerbsCache::kPROPFIND, XrdClHttp::VerbsCache::kUnset, XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers, XrdClHttp::CurlOperation::m_headers_list, and XrdClHttp::CurlOperation::Redirect().

Here is the call graph for this function:

ReleaseHandle()

void CurlStatOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlChecksumOp, and XrdClHttp::CurlOpenOp.

Definition at line 98 of file XrdClHttpOpStat.cc.

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

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

Referenced by XrdClHttp::CurlOpenOp::ReleaseHandle(), and XrdClHttp::CurlChecksumOp::ReleaseHandle().

Here is the call graph for this function:

Here is the caller graph for this function:

RequiresOptions()

bool CurlStatOp::RequiresOptions ( ) const

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 195 of file XrdClHttpOpStat.cc.

{
    auto &instance = VerbsCache::Instance();
    auto verbs = instance.Get(m_url);
    return verbs.IsSet(VerbsCache::HttpVerb::kUnset);
}

References XrdClHttp::VerbsCache::Instance(), XrdClHttp::VerbsCache::kUnset, and XrdClHttp::CurlOperation::m_url.

Here is the call graph for this function:

Setup()

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

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlChecksumOp.

Definition at line 78 of file XrdClHttpOpStat.cc.

{
    if (!CurlOperation::Setup(curl, worker)) return false;
    curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, CurlStatOp::WriteCallback);
    curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, this);
 
    auto &instance = VerbsCache::Instance();
    auto verbs = instance.Get(m_url);
    if (verbs.IsSet(VerbsCache::HttpVerb::kPROPFIND)) {
        curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, "PROPFIND");
        m_headers_list.emplace_back("Depth", "0");
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 0L);
        m_is_propfind = true;
    } else {
        curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 1L);
    }
    return true;
}

References XrdClHttp::VerbsCache::Instance(), XrdClHttp::VerbsCache::kPROPFIND, XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers_list, XrdClHttp::CurlOperation::m_url, and XrdClHttp::CurlOperation::Setup().

Referenced by XrdClHttp::CurlChecksumOp::Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

Success()

void CurlStatOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlQueryOp, XrdClHttp::CurlChecksumOp, and XrdClHttp::CurlOpenOp.

Definition at line 202 of file XrdClHttpOpStat.cc.

{
    SuccessImpl(true);
}

References SuccessImpl().

Here is the call graph for this function:

SuccessImpl()

void CurlStatOp::SuccessImpl ( bool  returnObj )

protected

Definition at line 208 of file XrdClHttpOpStat.cc.

{
    SetDone(false);
    m_logger->Debug(kLogXrdClHttp, "CurlStatOp::Success");
    if (m_handler == nullptr) {return;}
    XrdCl::AnyObject *obj = nullptr;
    if (returnObj) {
        auto [size, isdir] = GetStatInfo();
        if (size < 0) {
            m_logger->Error(kLogXrdClHttp, "Failed to get stat info for %s", m_url.c_str());
            Fail(XrdCl::errErrorResponse, kXR_FSError, "Server responded without object size");
            return;
        }
        if (m_is_propfind) {
            m_logger->Debug(kLogXrdClHttp, "Successful propfind operation on %s (size %lld, isdir %d)", m_url.c_str(), static_cast<long long>(size), isdir);
        } else {
            m_logger->Debug(kLogXrdClHttp, "Successful stat operation on %s (size %lld)", m_url.c_str(), static_cast<long long>(size));
        }
 
        XrdCl::StatInfo *stat_info;
        if (m_response_info){
            auto info = new XrdClHttp::StatResponse("nobody", size,
            XrdCl::StatInfo::Flags::IsReadable | (isdir ? XrdCl::StatInfo::Flags::IsDir : 0), time(NULL));
            info->SetResponseInfo(MoveResponseInfo());
            stat_info = info;
        } else {
            stat_info = new XrdCl::StatInfo("nobody", size,
            XrdCl::StatInfo::Flags::IsReadable | (isdir ? XrdCl::StatInfo::Flags::IsDir : 0), time(NULL));
        }
        obj = new XrdCl::AnyObject();
        obj->Set(stat_info);
    } else if (m_response_info) {
        auto info = new XrdClHttp::OpenResponseInfo();
        info->SetResponseInfo(MoveResponseInfo());
        obj = new XrdCl::AnyObject();
        obj->Set(info);
    }
 
    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(), GetStatInfo(), XrdCl::ResponseHandler::HandleResponse(), XrdClHttp::kLogXrdClHttp, kXR_FSError, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, XrdClHttp::CurlOperation::m_url, XrdClHttp::CurlOperation::MoveResponseInfo(), XrdCl::AnyObject::Set(), and XrdClHttp::CurlOperation::SetDone().

Referenced by XrdClHttp::CurlOpenOp::Fail(), Success(), and XrdClHttp::CurlOpenOp::Success().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• XrdClHttpOps.hh
• XrdClHttpOpStat.cc