XrdClS3::Filesystem Class Reference

#include <XrdClS3Filesystem.hh>

Inheritance diagram for XrdClS3::Filesystem:

Collaboration diagram for XrdClS3::Filesystem:

Public Member Functions
	Filesystem (const std::string &, XrdCl::Log *log)
virtual	~Filesystem () noexcept
virtual XrdCl::XRootDStatus	DirList (const std::string &path, XrdCl::DirListFlags::Flags flags, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual bool	GetProperty (const std::string &name, std::string &value) const override
virtual XrdCl::XRootDStatus	Locate (const std::string &path, XrdCl::OpenFlags::Flags flags, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	MkDir (const std::string &path, XrdCl::MkDirFlags::Flags flags, XrdCl::Access::Mode mode, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	Query (XrdCl::QueryCode::Code queryCode, const XrdCl::Buffer &arg, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	Rm (const std::string &path, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	RmDir (const std::string &path, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual bool	SetProperty (const std::string &name, const std::string &value) override
virtual XrdCl::XRootDStatus	Stat (const std::string &path, XrdCl::ResponseHandler *handler, time_t timeout) override
Public Member Functions inherited from XrdCl::FileSystemPlugIn
virtual	~FileSystemPlugIn ()
	Destructor.
virtual XRootDStatus	ChMod (const std::string &path, Access::Mode mode, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	DeepLocate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	DelXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	GetXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	ListXAttr (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Mv (const std::string &source, const std::string &dest, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Ping (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Protocol (ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	SendInfo (const std::string &info, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	SetXAttr (const std::string &path, const std::vector< xattr_t > &attrs, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	StatVFS (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Truncate (const std::string &path, uint64_t size, ResponseHandler *handler, time_t timeout)

Detailed Description

Definition at line 41 of file XrdClS3Filesystem.hh.

Constructor & Destructor Documentation

Filesystem()

Filesystem::Filesystem	(	const std::string &	url,
		XrdCl::Log *	log )

Definition at line 495 of file XrdClS3Filesystem.cc.

                                                          :
    m_logger(log),
    m_url(url)
{
    m_url.SetPath("");
    XrdCl::URL::ParamsMap map;
    m_url.SetParams(map);
 
    m_logger->Debug(kLogXrdClS3, "S3 filesystem constructed with URL: %s.",
        m_url.GetURL().c_str());
}

References XrdClS3::kLogXrdClS3.

~Filesystem()

Filesystem::~Filesystem ( )

virtualnoexcept

Definition at line 507 of file XrdClS3Filesystem.cc.

{}

Member Function Documentation

DirList()

XrdCl::XRootDStatus Filesystem::DirList ( const std::string & path, XrdCl::DirListFlags::Flags flags, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::DirlList

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 510 of file XrdClS3Filesystem.cc.

{
    std::string https_url, err_msg;
    const auto s3_url = XrdOucUtils::JoinUrl(m_url.GetURL(), path);
    std::string obj;
    if (!Factory::GenerateHttpUrl(s3_url, https_url, &obj, err_msg)) {
        return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errInvalidAddr, 0, err_msg);
    }
    obj = obj.substr(0, obj.find('?'));
    if (!obj.empty() && obj.back() != '/') {
        obj += "/";
    }
    auto query_loc = https_url.find('?');
    https_url += (query_loc == std::string::npos) ? "?" : "&";
    https_url += "list-type=2&delimiter=/&encoding-type=url";
    // An empty prefix= is dropped from the signature and the request is rejected.
    if (!obj.empty()) {
        https_url += "&prefix=" + urlquote(obj);
    }
 
    // File::Open turns a zero timeout into RequestTimeout for the first page.
    // The next page is fetched only while this deadline is still ahead, and
    // a zero timeout makes that deadline the current time.
    if (!timeout) {
        int val = XrdCl::DefaultRequestTimeout;
        XrdCl::DefaultEnv::GetEnv()->GetInt("RequestTimeout", val);
        timeout = val;
    }
    auto expiry = time(NULL) + timeout;
 
    return DownloadUrl(
        https_url,
        &m_header_callout,
        new DirListResponseHandler(
            false, https_url, obj, &m_header_callout, handler, expiry, *m_logger
        ), 
        timeout
    );
}

References XrdCl::DefaultRequestTimeout, XrdClS3::DownloadUrl(), XrdCl::errInvalidAddr, XrdClS3::Factory::GenerateHttpUrl(), XrdCl::DefaultEnv::GetEnv(), XrdCl::Env::GetInt(), XrdOucUtils::JoinUrl(), and XrdCl::stError.

Here is the call graph for this function:

GetProperty()

bool Filesystem::GetProperty ( const std::string & name, std::string & value ) const

overridevirtual

See also

XrdCl::FileSystem::GetProperty

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 594 of file XrdClS3Filesystem.cc.

{
    std::unique_lock lock(m_properties_mutex);
    const auto p = m_properties.find(name);
    if (p == std::end(m_properties)) {
        return false;
    }
 
    value = p->second;
    return true;
}

Locate()

XrdCl::XRootDStatus Filesystem::Locate ( const std::string & path, XrdCl::OpenFlags::Flags flags, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::Locate

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 608 of file XrdClS3Filesystem.cc.

{
    auto cleaned_path = Factory::CleanObjectName(path);
    auto [st, fs] = GetFSHandle(cleaned_path);
    if (!st.IsOK()) {
        return st;
    }
    return fs->Locate(cleaned_path, flags, handler, timeout);
}

References XrdClS3::Factory::CleanObjectName().

Here is the call graph for this function:

MkDir()

XrdCl::XRootDStatus Filesystem::MkDir ( const std::string & path, XrdCl::MkDirFlags::Flags flags, XrdCl::Access::Mode mode, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::MkDir

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 622 of file XrdClS3Filesystem.cc.

{
    auto sentinel = Factory::GetMkdirSentinel();
    if (sentinel.empty()) {
        if (handler) handler->HandleResponse(new XrdCl::XRootDStatus{}, nullptr);
        return {};
    }
    auto loc = input_path.find('?');
    auto path = input_path.substr(0, loc);
    if (!path.empty() && path[path.size() - 1] != '/') path += "/";
    path += sentinel;
    if (loc != std::string::npos) {
        path += input_path.substr(loc);
    }
 
    // Try creating a zero-sized sentinel.
    std::string https_url, err_msg;
    const auto s3_url = XrdOucUtils::JoinUrl(m_url.GetURL(), path);
    if (!Factory::GenerateHttpUrl(s3_url, https_url, nullptr, err_msg)) {
        return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errInvalidAddr, 0, err_msg);
    }
 
    XrdCl::File *http_file(new XrdCl::File(https_url));
 
    auto callout_loc = reinterpret_cast<long long>(&m_header_callout);
    size_t buf_size = 16;
    char callout_buf[buf_size];
    std::to_chars_result result = std::to_chars(callout_buf, callout_buf + buf_size - 1, callout_loc, 16);
    if (result.ec == std::errc{}) {
        std::string callout_str(callout_buf, result.ptr - callout_buf);
        http_file->SetProperty("XrdClHttpHeaderCallout", callout_str);
    }
 
    MkdirHandler *mkdirHandler = new MkdirHandler(http_file, handler, timeout);
 
    return http_file->Open(https_url, XrdCl::OpenFlags::Write, XrdCl::Access::None, mkdirHandler, timeout);
}

References XrdCl::errInvalidAddr, XrdClS3::Factory::GenerateHttpUrl(), XrdClS3::Factory::GetMkdirSentinel(), XrdCl::ResponseHandler::HandleResponse(), XrdOucUtils::JoinUrl(), XrdCl::Access::None, XrdCl::File::Open(), XrdCl::File::SetProperty(), XrdCl::stError, and XrdCl::OpenFlags::Write.

Here is the call graph for this function:

Query()

XrdCl::XRootDStatus Filesystem::Query ( XrdCl::QueryCode::Code queryCode, const XrdCl::Buffer & arg, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::Query

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 665 of file XrdClS3Filesystem.cc.

{
    if (queryCode != XrdCl::QueryCode::Checksum && queryCode != XrdCl::QueryCode::XAttr) {
        return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errNotImplemented);
    }
    auto cleaned_path = Factory::CleanObjectName(arg.ToString());
    auto [st, fs] = GetFSHandle(cleaned_path);
    if (!st.IsOK()) {
        return st;
    }
    XrdCl::Buffer cleanedArg;
    cleanedArg.FromString(cleaned_path);
    return fs->Query(queryCode, cleanedArg, handler, timeout);
}

References XrdCl::QueryCode::Checksum, XrdClS3::Factory::CleanObjectName(), XrdCl::errNotImplemented, XrdCl::Buffer::FromString(), XrdCl::stError, XrdCl::Buffer::ToString(), and XrdCl::QueryCode::XAttr.

Here is the call graph for this function:

Rm()

XrdCl::XRootDStatus Filesystem::Rm ( const std::string & path, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::Rm

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 685 of file XrdClS3Filesystem.cc.

{
    auto cleaned_path = Factory::CleanObjectName(path);
    auto [st, fs] = GetFSHandle(cleaned_path);
    if (!st.IsOK()) {
        return st;
    }
    return fs->Rm(cleaned_path, handler, timeout);
}

References XrdClS3::Factory::CleanObjectName().

Referenced by RmDir().

Here is the call graph for this function:

Here is the caller graph for this function:

RmDir()

XrdCl::XRootDStatus Filesystem::RmDir ( const std::string & path, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::RmDir

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 698 of file XrdClS3Filesystem.cc.

{
    auto sentinel = Factory::GetMkdirSentinel();
    if (sentinel.empty()) {
        if (handler) handler->HandleResponse(new XrdCl::XRootDStatus{}, nullptr);
        return {};
    }
    auto loc = input_path.find('?');
    auto path = input_path.substr(0, loc);
    if (!path.empty() && path[path.size() - 1] != '/') path += "/";
    path += sentinel;
    if (loc != std::string::npos) {
        path += input_path.substr(loc);
    }
    return Rm(path, handler, timeout);
}

References XrdClS3::Factory::GetMkdirSentinel(), XrdCl::ResponseHandler::HandleResponse(), and Rm().

Here is the call graph for this function:

SetProperty()

bool Filesystem::SetProperty ( const std::string & name, const std::string & value )

overridevirtual

See also

XrdCl::FileSystem::SetProperty

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 719 of file XrdClS3Filesystem.cc.

{
    std::unique_lock lock(m_properties_mutex);
    m_properties[name] = value;
    return true;
}

Stat()

XrdCl::XRootDStatus Filesystem::Stat ( const std::string & path, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::FileSystem::Stat

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 728 of file XrdClS3Filesystem.cc.

{
    auto cleaned_path = Factory::CleanObjectName(path);
    std::string https_url, err_msg, obj;
    const auto s3_url = XrdOucUtils::JoinUrl(m_url.GetURL(), cleaned_path);
    if (!Factory::GenerateHttpUrl(s3_url, https_url, &obj, err_msg)) {
        return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errInvalidAddr, 0, err_msg);
    }
    auto query = obj.find('?');
    if (query != std::string::npos) {
        obj.erase(query);
    }
    // HEAD of the bucket returns a zero-byte success. List it instead.
    if (obj.empty()) {
        auto query_loc = https_url.find('?');
        https_url += (query_loc == std::string::npos) ? "?" : "&";
        https_url += "list-type=2&delimiter=/&encoding-type=url";
        auto expiry = time(NULL) + timeout;
        return DownloadUrl(
            https_url,
            &m_header_callout,
            new DirListResponseHandler(
                true, https_url, "", &m_header_callout, new StatHandlerDirectory(handler), expiry, *m_logger
            ),
            timeout
        );
    }
    auto [st, fs] = GetFSHandle(cleaned_path);
    if (!st.IsOK()) {
        return st;
    }
    return fs->Stat(cleaned_path, new StatHandler(cleaned_path, m_url.GetURL(), &m_header_callout, handler, timeout, *m_logger), timeout);
}

References XrdClS3::Factory::CleanObjectName(), XrdClS3::DownloadUrl(), XrdCl::errInvalidAddr, XrdClS3::Factory::GenerateHttpUrl(), XrdOucUtils::JoinUrl(), and XrdCl::stError.

Here is the call graph for this function:

---

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

• XrdClS3Filesystem.hh
• XrdClS3Filesystem.cc