TPC::TPCHandler Class Reference

#include <XrdHttpTpcTPC.hh>

Inheritance diagram for TPC::TPCHandler:

Collaboration diagram for TPC::TPCHandler:

Public Member Functions
	TPCHandler (XrdSysError *log, const char *config, XrdOucEnv *myEnv)
virtual	~TPCHandler ()
virtual int	Init (const char *cfgfile)
	Initializes the external request handler. More...
virtual bool	MatchesPath (const char *verb, const char *path)
	Tells if the incoming path is recognized as one of the paths that have to be processed. More...
virtual int	ProcessReq (XrdHttpExtReq &req)
Public Member Functions inherited from XrdHttpExtHandler
	XrdHttpExtHandler ()
	Constructor. More...
virtual	~XrdHttpExtHandler ()
	Destructor. More...

Static Public Attributes
static constexpr std::string_view	OSS_TASK_OPAQUE = "oss.task=httptpc"

Detailed Description

Definition at line 48 of file XrdHttpTpcTPC.hh.

Constructor & Destructor Documentation

TPCHandler()

TPCHandler::TPCHandler	(	XrdSysError *	log,
		const char *	config,
		XrdOucEnv *	myEnv
	)

Definition at line 453 of file XrdHttpTpcTPC.cc.

                                                                             :
        m_allow_local(false),
        m_allow_private(true),
        m_desthttps(false),
        m_fixed_route(false),
        m_low_speed_limit(10*1024),
        m_low_speed_time(2*60),
        m_timeout(60),
        m_first_timeout(120),
        m_log(log->logger(), "TPC_"),
        m_sfs(NULL)
{
    if (!Configure(config, myEnv)) {
        throw std::runtime_error("Failed to configure the HTTP third-party-copy handler.");
    }
 
// Extract out the TPC monitoring object (we share it with xrootd).
//
   XrdXrootdGStream *gs = (XrdXrootdGStream*)myEnv->GetPtr("Tpc.gStream*");
   if (gs)
      TPCLogRecord::tpcMonitor = new XrdXrootdTpcMon("http",log->logger(),*gs);
}

References XrdOucEnv::GetPtr(), and XrdSysError::logger().

Here is the call graph for this function:

~TPCHandler()

TPCHandler::~TPCHandler ( )

virtual

Definition at line 445 of file XrdHttpTpcTPC.cc.

                        {
    m_sfs = NULL;
}

Member Function Documentation

Init()

virtual int TPC::TPCHandler::Init ( const char *  cfgfile )

inlinevirtual

Initializes the external request handler.

Implements XrdHttpExtHandler.

Definition at line 56 of file XrdHttpTpcTPC.hh.

{return 0;}

MatchesPath()

bool TPCHandler::MatchesPath ( const char *  verb, const char *  path  )

virtual

Tells if the incoming path is recognized as one of the paths that have to be processed.

Implements XrdHttpExtHandler.

Definition at line 364 of file XrdHttpTpcTPC.cc.

                                                               {
    return !strcmp(verb, "COPY") || !strcmp(verb, "OPTIONS");
}

ProcessReq()

int TPCHandler::ProcessReq ( XrdHttpExtReq &  )

virtual

Process an HTTP request and send the response using the calling XrdHttpProtocol instance directly Returns 0 if ok, non0 if errors

Implements XrdHttpExtHandler.

Definition at line 398 of file XrdHttpTpcTPC.cc.

                                             {
    if (req.verb == "OPTIONS") {
        return ProcessOptionsReq(req);
    }
    auto header = XrdOucTUtils::caseInsensitiveFind(req.headers,"credential");
    if (header != req.headers.end()) {
        if (header->second != "none") {
            m_log.Emsg("ProcessReq", "COPY requested an unsupported credential type: ", header->second.c_str());
            return req.SendSimpleResp(400, NULL, NULL, "COPY requestd an unsupported Credential type", 0);
        }
    }
    auto srcHeader = XrdOucTUtils::caseInsensitiveFind(req.headers,"source");
    auto dstHeader = XrdOucTUtils::caseInsensitiveFind(req.headers,"destination");
    // A Source header asks for a pull, a Destination header for a push; asking
    // for both at once is ambiguous, so the request is rejected instead of
    // arbitrarily honouring one of the two.
    if (srcHeader != req.headers.end() && dstHeader != req.headers.end()) {
        const char *error_both = "COPY rejected: both a Source and a Destination header were specified";
        m_log.Emsg("ProcessReq", error_both);
        return req.SendSimpleResp(400, NULL, NULL, error_both, 0);
    }
    if (srcHeader != req.headers.end()) {
        std::string src = PrepareURL(srcHeader->second);
        if (!IsAllowedScheme(src)) {
            const char *error_src = "COPY rejected: disallowed scheme in source URL";
            m_log.Emsg("ProcessReq", error_src, src.c_str());
            return req.SendSimpleResp(400, NULL, NULL, error_src, 0);
        }
        return ProcessPullReq(src, req);
    }
    if (dstHeader != req.headers.end()) {
        const std::string& dst = dstHeader->second;
        if (!IsAllowedScheme(dst)) {
            const char *error_dst = "COPY rejected: disallowed scheme in destination URL";
            m_log.Emsg("ProcessReq", error_dst, dst.c_str());
            return req.SendSimpleResp(400, NULL, NULL, error_dst, 0);
        }
        return ProcessPushReq(dst, req);
    }
    m_log.Emsg("ProcessReq", "COPY verb requested but no source or destination specified.");
    return req.SendSimpleResp(400, NULL, NULL, "No Source or Destination specified", 0);
}

References XrdOucTUtils::caseInsensitiveFind(), XrdSysError::Emsg(), XrdHttpExtReq::headers, IsAllowedScheme(), PrepareURL(), XrdHttpExtReq::SendSimpleResp(), and XrdHttpExtReq::verb.

Here is the call graph for this function:

Member Data Documentation

OSS_TASK_OPAQUE

constexpr std::string_view TPC::TPCHandler::OSS_TASK_OPAQUE = "oss.task=httptpc"

staticconstexpr

Definition at line 57 of file XrdHttpTpcTPC.hh.

Referenced by XrdHttpTpcUtils::prepareOpenURL().

---

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

• XrdHttpTpcTPC.hh
• XrdHttpTpcConfigure.cc
• XrdHttpTpcMultistream.cc
• XrdHttpTpcTPC.cc