edm::FileLocator Class Reference

#include <FileLocator.h>

Classes
struct	Rule

Public Member Functions
	FileLocator (std::string const &catUrl, unsigned iCatalog=0)
std::string	lfn (std::string const &ipfn) const
std::string	pfn (std::string const &ilfn) const
	~FileLocator ()

Private Types
typedef std::map< std::string, Rules >	ProtocolRules
typedef std::vector< Rule >	Rules

Private Member Functions
std::string	applyRules (ProtocolRules const &protocolRules, std::string const &protocol, std::string const &destination, bool direct, std::string name) const
std::string	convert (std::string const &input, ProtocolRules const &rules, bool direct) const
void	init (std::string const &catUrl, unsigned iCatalog)
void	parseRule (tinyxml2::XMLElement *ruleNode, ProtocolRules &rules)

Private Attributes
std::string	m_destination
ProtocolRules	m_directRules
std::string	m_filename
std::string	m_fileType
ProtocolRules	m_inverseRules
std::vector< std::string >	m_protocols

Static Private Attributes
static int	s_numberOfInstances

Detailed Description

Definition at line 13 of file FileLocator.h.

Member Typedef Documentation

ProtocolRules

typedef std::map<std::string, Rules> edm::FileLocator::ProtocolRules

private

Definition at line 35 of file FileLocator.h.

Rules

typedef std::vector<Rule> edm::FileLocator::Rules

private

Definition at line 34 of file FileLocator.h.

Constructor & Destructor Documentation

FileLocator()

edm::FileLocator::FileLocator ( std::string const &  catUrl, unsigned  iCatalog = 0  )

explicit

Definition at line 45 of file FileLocator.cc.

                                                                     : m_destination("any") {
    init(catUrl, iCatalog);
 
    // std::cout << m_protocols.size() << " protocols" << std::endl;
    // std::cout << m_directRules[m_protocols[0]].size() << " rules" << std::endl;
  }

References init().

~FileLocator()

edm::FileLocator::~FileLocator

(

)

Definition at line 52 of file FileLocator.cc.

{}

Member Function Documentation

applyRules()

std::string edm::FileLocator::applyRules ( ProtocolRules const &  protocolRules, std::string const &  protocol, std::string const &  destination, bool  direct, std::string  name  ) const

private

Definition at line 190 of file FileLocator.cc.

                                                            {
    // std::cerr << "Calling apply rules with protocol: " << protocol << "\n destination: " << destination << "\n " << " on name " << name << std::endl;
 
    ProtocolRules::const_iterator const rulesIterator = protocolRules.find(protocol);
    if (rulesIterator == protocolRules.end()) {
      return "";
    }
 
    Rules const& rules = (*(rulesIterator)).second;
 
    std::smatch destinationMatches;
    std::smatch nameMatches;
 
    /* Look up for a matching rule*/
    for (Rules::const_iterator i = rules.begin(); i != rules.end(); ++i) {
      if (!std::regex_match(destination, destinationMatches, i->destinationMatch)) {
        continue;
      }
 
      if (!std::regex_match(name, i->pathMatch)) {
        continue;
      }
 
      // std::cerr << "Rule " << i->pathMatch << "matched! " << std::endl;
 
      std::string const chain = i->chain;
      if ((direct == true) && (!chain.empty())) {
        name = applyRules(protocolRules, chain, destination, direct, name);
        if (name.empty()) {
          return "";
        }
      }
 
      std::regex_match(name, nameMatches, i->pathMatch);
      name = replaceWithRegexp(nameMatches, i->result);
 
      if ((direct == false) && (!chain.empty())) {
        name = applyRules(protocolRules, chain, destination, direct, name);
      }
      return name;
    }
    return "";
  }

References HLTMuonOfflineAnalyzer_cff::destination, mps_fire::i, Skims_PA_cff::name, cmsCodeRulesChecker::rules, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by convert().

convert()

std::string edm::FileLocator::convert ( std::string const &  input, ProtocolRules const &  rules, bool  direct  ) const

private

Definition at line 58 of file FileLocator.cc.

                                                                                                      {
    std::string out = "";
 
    for (size_t pi = 0, pe = m_protocols.size(); pi != pe; ++pi) {
      out = applyRules(rules, m_protocols[pi], m_destination, direct, input);
      if (!out.empty())
        return out;
    }
    return out;
  }

References applyRules(), input, m_destination, m_protocols, MillePedeFileConverter_cfg::out, pi, cmsCodeRulesChecker::rules, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by lfn(), and pfn().

init()

void edm::FileLocator::init ( std::string const &  catUrl, unsigned  iCatalog  )

private

Definition at line 92 of file FileLocator.cc.

                                                                   {
    std::string m_url = catUrl;
 
    if (m_url.empty()) {
      Service<SiteLocalConfig> localconfservice;
      if (!localconfservice.isAvailable())
        throw cms::Exception("TrivialFileCatalog", "edm::SiteLocalConfigService is not available");
      if (iCatalog >= localconfservice->dataCatalogs().size())
        throw cms::Exception("TrivialFileCatalog", "edm::FileLocator: Request nonexistence data catalog");
      m_url = localconfservice->dataCatalogs()[iCatalog];
    }
 
    if (m_url.find("file:") == std::string::npos) {
      throw cms::Exception("TrivialFileCatalog",
                           "TrivialFileCatalog::connect: Malformed url for file catalog configuration");
    }
 
    m_url = m_url.erase(0, m_url.find(':') + 1);
 
    std::vector<std::string> tokens;
    boost::algorithm::split(tokens, m_url, boost::is_any_of(std::string("?")));
    m_filename = tokens[0];
 
    if (tokens.size() == 2) {
      std::string const options = tokens[1];
      std::vector<std::string> optionTokens;
      boost::algorithm::split(optionTokens, options, boost::is_any_of(std::string("&")));
 
      std::string const equalSign("=");
      std::string const comma(",");
 
      for (size_t oi = 0, oe = optionTokens.size(); oi != oe; ++oi) {
        std::string const option = optionTokens[oi];
        std::vector<std::string> argTokens;
        boost::algorithm::split(argTokens, option, boost::is_any_of(equalSign));
 
        if (argTokens.size() != 2) {
          throw cms::Exception("TrivialFileCatalog",
                               "TrivialFileCatalog::connect: Malformed url for file catalog configuration");
        }
 
        if (argTokens[0] == "protocol") {
          boost::algorithm::split(m_protocols, argTokens[1], boost::is_any_of(comma));
        } else if (argTokens[0] == "destination") {
          m_destination = argTokens[1];
        }
      }
    }
 
    if (m_protocols.empty()) {
      throw cms::Exception("TrivialFileCatalog",
                           "TrivialFileCatalog::connect: protocol was not supplied in the contact string");
    }
 
    std::ifstream configFile;
    configFile.open(m_filename.c_str());
 
    //
    // std::cout << "Using catalog configuration " << m_filename << std::endl;
 
    if (!configFile.good() || !configFile.is_open()) {
      throw cms::Exception("TrivialFileCatalog",
                           "TrivialFileCatalog::connect: Unable to open trivial file catalog " + m_filename);
    }
 
    configFile.close();
 
    tinyxml2::XMLDocument doc;
    auto loadErr = doc.LoadFile(m_filename.c_str());
    if (loadErr != tinyxml2::XML_SUCCESS) {
      throw cms::Exception("TrivialFileCatalog")
          << "tinyxml file load failed with error : " << doc.ErrorStr() << std::endl;
    }
    /* trivialFileCatalog matches the following xml schema
     FIXME: write a proper DTD
     <storage-mapping>
     <lfn-to-pfn protocol="direct" destination-match=".*"
     path-match="lfn/guid match regular expression"
     result="/castor/cern.ch/cms/$1"/>
     <pfn-to-lfn protocol="srm"
     path-match="lfn/guid match regular expression"
     result="$1"/>
     </storage-mapping>
    */
    auto rootElement = doc.RootElement();
    /*first of all do the lfn-to-pfn bit*/
    for (auto el = rootElement->FirstChildElement("lfn-to-pfn"); el != nullptr;
         el = el->NextSiblingElement("lfn-to-pfn")) {
      parseRule(el, m_directRules);
    }
 
    /*Then we handle the pfn-to-lfn bit*/
    for (auto el = rootElement->FirstChildElement("pfn-to-lfn"); el != nullptr;
         el = el->NextSiblingElement("pfn-to-lfn")) {
      parseRule(el, m_inverseRules);
    }
  }

References findQualityFiles::comma, common_cff::doc, Exception, edm::Service< T >::isAvailable(), m_destination, m_directRules, m_filename, m_inverseRules, m_protocols, fileinputsource_cfi::option, parseRule(), submitPVValidationJobs::split(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by FileLocator().

lfn()

std::string edm::FileLocator::lfn

(

std::string const &

ipfn

)

const

Definition at line 56 of file FileLocator.cc.

{ return convert(ipfn, m_inverseRules, false); }

References convert(), and m_inverseRules.

parseRule()

void edm::FileLocator::parseRule ( tinyxml2::XMLElement *  ruleNode, ProtocolRules &  rules  )

private

Definition at line 69 of file FileLocator.cc.

                                                                                   {
    if (!ruleElement) {
      throw cms::Exception("TrivialFileCatalog", std::string("TrivialFileCatalog::connect: Malformed trivial catalog"));
    }
 
    auto const protocol = safe(ruleElement->Attribute("protocol"));
    auto destinationMatchRegexp = ruleElement->Attribute("destination-match");
    if (destinationMatchRegexp == nullptr or destinationMatchRegexp[0] == 0) {
      destinationMatchRegexp = ".*";
    }
 
    auto const pathMatchRegexp = safe(ruleElement->Attribute("path-match"));
    auto const result = safe(ruleElement->Attribute("result"));
    auto const chain = safe(ruleElement->Attribute("chain"));
 
    Rule rule;
    rule.pathMatch.assign(pathMatchRegexp);
    rule.destinationMatch.assign(destinationMatchRegexp);
    rule.result = result;
    rule.chain = chain;
    rules[protocol].emplace_back(std::move(rule));
  }

References Exception, eostools::move(), or, edm::FileLocator::Rule::pathMatch, mps_fire::result, cmsCodeRulesChecker::rules, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by init().

pfn()

std::string edm::FileLocator::pfn

(

std::string const &

ilfn

)

const

Definition at line 54 of file FileLocator.cc.

{ return convert(ilfn, m_directRules, true); }

References convert(), and m_directRules.

Member Data Documentation

m_destination

std::string edm::FileLocator::m_destination

private

Definition at line 57 of file FileLocator.h.

Referenced by convert(), and init().

m_directRules

ProtocolRules edm::FileLocator::m_directRules

private

Direct rules are used to do the mapping from LFN to PFN.

Definition at line 50 of file FileLocator.h.

Referenced by init(), and pfn().

m_filename

std::string edm::FileLocator::m_filename

private

Definition at line 55 of file FileLocator.h.

Referenced by init().

m_fileType

std::string edm::FileLocator::m_fileType

private

Definition at line 54 of file FileLocator.h.

m_inverseRules

ProtocolRules edm::FileLocator::m_inverseRules

private

Inverse rules are used to do the mapping from PFN to LFN

Definition at line 52 of file FileLocator.h.

Referenced by init(), and lfn().

m_protocols

std::vector<std::string> edm::FileLocator::m_protocols

private

Definition at line 56 of file FileLocator.h.

Referenced by convert(), and init().

s_numberOfInstances

int edm::FileLocator::s_numberOfInstances

staticprivate

For the time being the only allowed configuration item is a prefix to be added to the GUID/LFN.

Definition at line 25 of file FileLocator.h.