XRootD
XrdCl::HttpFileSystemPlugIn Class Reference

#include <XrdClHttpFileSystemPlugIn.hh>

+ Inheritance diagram for XrdCl::HttpFileSystemPlugIn:
+ Collaboration diagram for XrdCl::HttpFileSystemPlugIn:

Public Member Functions

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

Detailed Description

Definition at line 18 of file XrdClHttpFileSystemPlugIn.hh.

Constructor & Destructor Documentation

◆ HttpFileSystemPlugIn()

XrdCl::HttpFileSystemPlugIn::HttpFileSystemPlugIn ( const std::string &  url)

Definition at line 24 of file XrdClHttpFileSystemPlugIn.cc.

25  : url_(url), logger_(DefaultEnv::GetLog()) {
26  SetUpLogging(logger_);
27  logger_->Debug(kLogXrdClHttp,
28  "HttpFileSystemPlugIn constructed with URL: %s.",
29  url_.GetObfuscatedURL().c_str());
30  std::string origin = getenv("XRDXROOTD_PROXY")? getenv("XRDXROOTD_PROXY") : "";
31 
32  if (getenv("DAVIX_DBG_LOGGING_IN_XRD")) {
33  Davix::setLogScope(DAVIX_LOG_HEADER | DAVIX_LOG_S3 | DAVIX_LOG_BODY | DAVIX_LOG_CHAIN);
34  Davix::setLogLevel(DAVIX_LOG_DEBUG);
35  }
36  if ( origin.empty() || origin.find("=") == 0) {
37  ctx_ = new Davix::Context();
38  davix_client_ = new Davix::DavPosix(ctx_);
39  }
40  else {
41  if (root_ctx_ == NULL) {
42  root_ctx_ = new Davix::Context();
43  if (getenv("DAVIX_LOAD_GRID_MODULE_IN_XRD"))
44  root_ctx_->loadModule("grid");
45  root_davix_client_ = new Davix::DavPosix(root_ctx_);
46  }
47  ctx_ = root_ctx_;
48  davix_client_ = root_davix_client_;
49  }
50 }
static Log * GetLog()
Get default log.
void Debug(uint64_t topic, const char *format,...)
Print a debug message.
Definition: XrdClLog.cc:282
std::string GetObfuscatedURL() const
Get the URL with authz information obfuscated.
Definition: XrdClURL.cc:491
Davix::Context * root_ctx_
Davix::DavPosix * root_davix_client_
void SetUpLogging(Log *logger)
static const uint64_t kLogXrdClHttp

References XrdCl::Log::Debug(), XrdCl::URL::GetObfuscatedURL(), XrdCl::kLogXrdClHttp, XrdCl::root_ctx_, XrdCl::root_davix_client_, and XrdCl::SetUpLogging().

+ Here is the call graph for this function:

◆ ~HttpFileSystemPlugIn()

XrdCl::HttpFileSystemPlugIn::~HttpFileSystemPlugIn ( )
virtualnoexcept

Definition at line 55 of file XrdClHttpFileSystemPlugIn.cc.

55  {
56  int rc = errno;
57  if (root_ctx_ == NULL) {
58  delete davix_client_;
59  delete ctx_;
60  }
61  errno = rc;
62 }

References XrdCl::root_ctx_.

Member Function Documentation

◆ DirList()

XRootDStatus XrdCl::HttpFileSystemPlugIn::DirList ( const std::string &  path,
DirListFlags::Flags  flags,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::DirlList

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 162 of file XrdClHttpFileSystemPlugIn.cc.

165  {
166  auto url = url_;
167  url.SetPath(path);
168  const auto full_path = url.GetLocation();
169 
170  logger_->Debug(
172  "HttpFileSystemPlugIn::DirList - path = %s, flags = %d, timeout = %d",
173  full_path.c_str(), flags, timeout);
174 
175  const bool details = flags & DirListFlags::Stat;
176  const bool recursive = flags & DirListFlags::Recursive;
177 
178  // res == std::pair<DirectoryList*, XRootDStatus>
179  auto res =
180  Posix::DirList(*davix_client_, full_path, details, recursive, timeout);
181  if (res.second.IsError()) {
182  logger_->Error(kLogXrdClHttp, "Could not list dir: %s, error: %s",
183  full_path.c_str(), res.second.ToStr().c_str());
184  return res.second;
185  }
186 
187  auto obj = new AnyObject();
188  obj->Set(res.first);
189 
190  handler->HandleResponse(new XRootDStatus(), obj);
191  return XRootDStatus();
192 }
void Error(uint64_t topic, const char *format,...)
Report an error.
Definition: XrdClLog.cc:231
void SetPath(const std::string &path)
Set the path.
Definition: XrdClURL.hh:225
std::pair< XrdCl::DirectoryList *, XrdCl::XRootDStatus > DirList(Davix::DavPosix &davix_client, const std::string &path, bool details, bool, uint16_t timeout)
@ Stat
Stat each entry.
@ Recursive
Do a recursive listing.

References XrdCl::Log::Debug(), Posix::DirList(), XrdCl::Log::Error(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, XrdCl::DirListFlags::Recursive, XrdCl::URL::SetPath(), and XrdCl::DirListFlags::Stat.

+ Here is the call graph for this function:

◆ GetProperty()

bool XrdCl::HttpFileSystemPlugIn::GetProperty ( const std::string &  name,
std::string &  value 
) const
overridevirtual
See also
XrdCl::FileSystem::GetProperty

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 229 of file XrdClHttpFileSystemPlugIn.cc.

230  {
231  const auto p = properties_.find(name);
232  if (p == std::end(properties_)) {
233  return false;
234  }
235 
236  value = p->second;
237  return true;
238 }

◆ MkDir()

XRootDStatus XrdCl::HttpFileSystemPlugIn::MkDir ( const std::string &  path,
MkDirFlags::Flags  flags,
Access::Mode  mode,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::MkDir

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 118 of file XrdClHttpFileSystemPlugIn.cc.

122  {
123  auto url = url_;
124  url.SetPath(path);
125 
126  logger_->Debug(
128  "HttpFileSystemPlugIn::MkDir - path = %s, flags = %d, timeout = %d",
129  url.GetObfuscatedURL().c_str(), flags, timeout);
130 
131  auto status = Posix::MkDir(*davix_client_, url.GetURL(), flags, mode, timeout);
132  if (status.IsError()) {
133  logger_->Error(kLogXrdClHttp, "MkDir failed: %s", status.ToStr().c_str());
134  return status;
135  }
136 
137  handler->HandleResponse(new XRootDStatus(status), nullptr);
138 
139  return XRootDStatus();
140 }
XRootDStatus MkDir(Davix::DavPosix &davix_client, const std::string &path, XrdCl::MkDirFlags::Flags flags, XrdCl::Access::Mode, uint16_t timeout)

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, Posix::MkDir(), and XrdCl::URL::SetPath().

+ Here is the call graph for this function:

◆ Mv()

XRootDStatus XrdCl::HttpFileSystemPlugIn::Mv ( const std::string &  source,
const std::string &  dest,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::Mv

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 64 of file XrdClHttpFileSystemPlugIn.cc.

67  {
68  //const auto full_source_path = url_.GetLocation() + source;
69  //const auto full_dest_path = url_.GetLocation() + dest;
70  const auto full_source_path = url_.GetProtocol() + "://"
71  + url_.GetHostName() + ":"
72  + std::to_string(url_.GetPort())
73  + source;
74  const auto full_dest_path = url_.GetProtocol() + "://"
75  + url_.GetHostName() + ":"
76  + std::to_string(url_.GetPort())
77  + dest;
78 
79  logger_->Debug(kLogXrdClHttp,
80  "HttpFileSystemPlugIn::Mv - src = %s, dest = %s, timeout = %d",
81  full_source_path.c_str(), full_dest_path.c_str(), timeout);
82 
83  auto status =
84  Posix::Rename(*davix_client_, full_source_path, full_dest_path, timeout);
85 
86  if (status.IsError()) {
87  logger_->Error(kLogXrdClHttp, "Mv failed: %s", status.ToStr().c_str());
88  return status;
89  }
90 
91  handler->HandleResponse(new XRootDStatus(status), nullptr);
92 
93  return XRootDStatus();
94 }
const std::string & GetHostName() const
Get the name of the target host.
Definition: XrdClURL.hh:170
const std::string & GetProtocol() const
Get the protocol.
Definition: XrdClURL.hh:118
int GetPort() const
Get the target port.
Definition: XrdClURL.hh:188
XRootDStatus Rename(Davix::DavPosix &davix_client, const std::string &source, const std::string &dest, uint16_t timeout)

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::URL::GetHostName(), XrdCl::URL::GetPort(), XrdCl::URL::GetProtocol(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, and Posix::Rename().

+ Here is the call graph for this function:

◆ Rm()

XRootDStatus XrdCl::HttpFileSystemPlugIn::Rm ( const std::string &  path,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::Rm

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 96 of file XrdClHttpFileSystemPlugIn.cc.

98  {
99  auto url = url_;
100  url.SetPath(path);
101 
102  logger_->Debug(kLogXrdClHttp,
103  "HttpFileSystemPlugIn::Rm - path = %s, timeout = %d",
104  url.GetObfuscatedURL().c_str(), timeout);
105 
106  auto status = Posix::Unlink(*davix_client_, url.GetURL(), timeout);
107 
108  if (status.IsError()) {
109  logger_->Error(kLogXrdClHttp, "Rm failed: %s", status.ToStr().c_str());
110  return status;
111  }
112 
113  handler->HandleResponse(new XRootDStatus(status), nullptr);
114 
115  return XRootDStatus();
116 }
XRootDStatus Unlink(Davix::DavPosix &davix_client, const std::string &url, uint16_t timeout)

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, XrdCl::URL::SetPath(), and Posix::Unlink().

+ Here is the call graph for this function:

◆ RmDir()

XRootDStatus XrdCl::HttpFileSystemPlugIn::RmDir ( const std::string &  path,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::RmDir

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 142 of file XrdClHttpFileSystemPlugIn.cc.

144  {
145  auto url = url_;
146  url.SetPath(path);
147 
148  logger_->Debug(kLogXrdClHttp,
149  "HttpFileSystemPlugIn::RmDir - path = %s, timeout = %d",
150  url.GetObfuscatedURL().c_str(), timeout);
151 
152  auto status = Posix::RmDir(*davix_client_, url.GetURL(), timeout);
153  if (status.IsError()) {
154  logger_->Error(kLogXrdClHttp, "RmDir failed: %s", status.ToStr().c_str());
155  return status;
156  }
157 
158  handler->HandleResponse(new XRootDStatus(status), nullptr);
159  return XRootDStatus();
160 }
XRootDStatus RmDir(Davix::DavPosix &davix_client, const std::string &path, uint16_t timeout)

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, Posix::RmDir(), and XrdCl::URL::SetPath().

+ Here is the call graph for this function:

◆ SetProperty()

bool XrdCl::HttpFileSystemPlugIn::SetProperty ( const std::string &  name,
const std::string &  value 
)
overridevirtual
See also
XrdCl::FileSystem::SetProperty

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 223 of file XrdClHttpFileSystemPlugIn.cc.

224  {
225  properties_[name] = value;
226  return true;
227 }

◆ Stat()

XRootDStatus XrdCl::HttpFileSystemPlugIn::Stat ( const std::string &  path,
ResponseHandler handler,
uint16_t  timeout 
)
overridevirtual
See also
XrdCl::FileSystem::Stat

Reimplemented from XrdCl::FileSystemPlugIn.

Definition at line 194 of file XrdClHttpFileSystemPlugIn.cc.

196  {
197  //const auto full_path = url_.GetLocation() + path;
198  const auto full_path = url_.GetProtocol() + "://" +
199  url_.GetHostName() + ":" +
200  std::to_string(url_.GetPort()) + "/" + path;
201 
202  logger_->Debug(kLogXrdClHttp,
203  "HttpFileSystemPlugIn::Stat - path = %s, timeout = %d",
204  full_path.c_str(), timeout);
205 
206  auto stat_info = new StatInfo();
207  //XRootDStatus status;
208  auto status = Posix::Stat(*davix_client_, full_path, timeout, stat_info);
209 
210  if (status.IsError()) {
211  logger_->Error(kLogXrdClHttp, "Stat failed: %s", status.ToStr().c_str());
212  return status;
213  }
214 
215  auto obj = new AnyObject();
216  obj->Set(stat_info);
217 
218  handler->HandleResponse(new XRootDStatus(), obj);
219 
220  return XRootDStatus();
221 }
XRootDStatus Stat(Davix::DavPosix &davix_client, const std::string &url, uint16_t timeout, StatInfo *stat_info)

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::URL::GetHostName(), XrdCl::URL::GetPort(), XrdCl::URL::GetProtocol(), XrdCl::ResponseHandler::HandleResponse(), XrdCl::kLogXrdClHttp, and Posix::Stat().

+ Here is the call graph for this function:

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