edm::InputFileCatalog Class Reference

#include <InputFileCatalog.h>

Public Member Functions
bool	empty () const
std::vector< FileCatalogItem > const &	fileCatalogItems () const
std::vector< std::string >	fileNames (unsigned iCatalog) const
	InputFileCatalog (std::vector< std::string > const &fileNames, std::string const &override, bool useLFNasPFNifLFNnotFound=false, edm::CatalogType catType=edm::CatalogType::RucioCatalog)
std::vector< std::string > const &	logicalFileNames () const
	~InputFileCatalog ()

Static Public Member Functions
static bool	isPhysical (std::string const &name)

Private Member Functions
void	findFile (std::string const &lfn, std::vector< std::string > &pfns, bool useLFNasPFNifLFNnotFound, edm::CatalogType catType)
void	init (std::string const &override, bool useLFNasPFNifLFNnotFound, edm::CatalogType catType)

Private Attributes
std::vector< FileCatalogItem >	fileCatalogItems_
std::vector< edm::propagate_const< std::unique_ptr< FileLocator > > >	fileLocators_
std::vector< edm::propagate_const< std::unique_ptr< FileLocator > > >	fileLocators_trivalCatalog_
std::vector< std::string >	fileNames_
std::vector< std::string >	logicalFileNames_
edm::propagate_const< std::unique_ptr< FileLocator > >	overrideFileLocator_

Detailed Description

Definition at line 34 of file InputFileCatalog.h.

Constructor & Destructor Documentation

InputFileCatalog()

edm::InputFileCatalog::InputFileCatalog	(	std::vector< std::string > const &	fileNames,
		std::string const &	override,
		bool	useLFNasPFNifLFNnotFound = false,
		edm::CatalogType	catType = edm::CatalogType::RucioCatalog
	)

Definition at line 20 of file InputFileCatalog.cc.

References init().

      : logicalFileNames_(fileNames), fileNames_(fileNames), fileCatalogItems_(), overrideFileLocator_() {
    init(override, useLFNasPFNifLFNnotFound, catType);
  }

~InputFileCatalog()

edm::InputFileCatalog::~InputFileCatalog

(

)

Definition at line 28 of file InputFileCatalog.cc.

{}

Member Function Documentation

empty()

bool edm::InputFileCatalog::empty ( void  ) const

inline

Definition at line 47 of file InputFileCatalog.h.

References fileCatalogItems_.

Referenced by edm::PoolSource::PoolSource().

{ return fileCatalogItems_.empty(); }

fileCatalogItems()

std::vector<FileCatalogItem> const& edm::InputFileCatalog::fileCatalogItems ( ) const

inline

Definition at line 44 of file InputFileCatalog.h.

References fileCatalogItems_.

Referenced by edm::RootInputFileSequence::fileCatalogItems(), and DQMRootSource::readFile_().

{ return fileCatalogItems_; }

fileNames()

std::vector< std::string > edm::InputFileCatalog::fileNames

(

unsigned

iCatalog

)

const

Definition at line 30 of file InputFileCatalog.cc.

References fileCatalogItems_, B2GTnPMonitor_cfi::item, and createJobs::tmp.

Referenced by edm::FromFiles::fileNames(), and DQMRootSource::readFile_().

                                                                          {
    std::vector<std::string> tmp;
    tmp.reserve(fileCatalogItems_.size());
    for (auto const& item : fileCatalogItems_) {
      tmp.push_back(item.fileName(iCatalog));
    }
    return tmp;
  }

findFile()

void edm::InputFileCatalog::findFile ( std::string const &  lfn, std::vector< std::string > &  pfns, bool  useLFNasPFNifLFNnotFound, edm::CatalogType  catType  )

private

Definition at line 155 of file InputFileCatalog.cc.

References cms::Exception::addContext(), fileLocators_, fileLocators_trivalCatalog_, overrideFileLocator_, edm::RucioCatalog, AlCaHLTBitMon_QueryRunRegistry::string, and edm::TrivialCatalog.

Referenced by init().

                                                          {
    if (overrideFileLocator_) {
      pfns.push_back(overrideFileLocator_->pfn(lfn, catType));
    } else {
      if (catType == edm::CatalogType::TrivialCatalog) {
        for (auto const& locator : fileLocators_trivalCatalog_) {
          std::string pfn = locator->pfn(lfn, edm::CatalogType::TrivialCatalog);
          if (pfn.empty() && useLFNasPFNifLFNnotFound)
            pfns.push_back(lfn);
          else
            pfns.push_back(pfn);
        }
      } else if (catType == edm::CatalogType::RucioCatalog) {
        for (auto const& locator : fileLocators_) {
          std::string pfn = locator->pfn(lfn, edm::CatalogType::RucioCatalog);
          if (pfn.empty() && useLFNasPFNifLFNnotFound)
            pfns.push_back(lfn);
          else
            pfns.push_back(pfn);
        }
      } else {
        cms::Exception ex("FileCatalog");
        ex << "Undefined catalog type";
        ex.addContext("Calling edm::InputFileCatalog::findFile()");
        throw ex;
      }
    }

    // Empty PFN will be found by caller.
  }

init()

void edm::InputFileCatalog::init ( std::string const &  override, bool  useLFNasPFNifLFNnotFound, edm::CatalogType  catType  )

private

Definition at line 39 of file InputFileCatalog.cc.

References cms::Exception::addContext(), getEcalConditions_orcoffint2r_cff::catalog, MillePedeFileConverter_cfg::e, fileCatalogItems_, fileLocators_, fileLocators_trivalCatalog_, fileNames_, findFile(), edm::Service< T >::isAvailable(), isPhysical(), logicalFileNames_, overrideFileLocator_, edm::RucioCatalog, submitPVValidationJobs::split(), AlCaHLTBitMon_QueryRunRegistry::string, trim(), and edm::TrivialCatalog.

Referenced by InputFileCatalog().

                                                      {
    typedef std::vector<std::string>::iterator iter;

    if (!overrideFileLocator_ && !inputOverride.empty()) {
      if (catType == edm::CatalogType::TrivialCatalog) {
        overrideFileLocator_ =
            std::make_unique<FileLocator>(inputOverride);  // propagate_const<T> has no reset() function
      } else if (catType == edm::CatalogType::RucioCatalog) {
        //now make a struct from input string
        std::vector<std::string> tmps;
        boost::algorithm::split(tmps, inputOverride, boost::is_any_of(std::string(",")));
        if (tmps.size() != 5) {
          cms::Exception ex("FileCatalog");
          ex << "Trying to override input file catalog but invalid input override string " << inputOverride
             << " (Should be site,subSite,storageSite,volume,protocol)";
          ex.addContext("Calling edm::InputFileCatalog::init()");
          throw ex;
        }

        edm::CatalogAttributes inputOverride_struct(tmps[0],   //current-site
                                                    tmps[1],   //current-subSite
                                                    tmps[2],   //desired-data-access-site
                                                    tmps[3],   //desired-data-access-volume
                                                    tmps[4]);  //desired-data-access-protocol

        overrideFileLocator_ =
            std::make_unique<FileLocator>(inputOverride_struct);  // propagate_const<T> has no reset() function
      }
    }

    Service<SiteLocalConfig> localconfservice;
    if (!localconfservice.isAvailable()) {
      cms::Exception ex("FileCatalog");
      ex << "edm::SiteLocalConfigService is not available";
      ex.addContext("Calling edm::InputFileCatalog::init()");
      throw ex;
    }

    if (catType == edm::CatalogType::TrivialCatalog) {
      std::vector<std::string> const& tmp_dataCatalogs = localconfservice->trivialDataCatalogs();
      if (!fileLocators_trivalCatalog_.empty())
        fileLocators_trivalCatalog_.clear();
      //Construct all file locators from data catalogs. If a data catalog is invalid (wrong protocol for example), it is skipped and no file locator is constructed (an exception is thrown out from FileLocator::init).
      for (const auto& catalog : tmp_dataCatalogs) {
        try {
          fileLocators_trivalCatalog_.push_back(std::make_unique<FileLocator>(catalog));
        } catch (cms::Exception const& e) {
          edm::LogWarning("InputFileCatalog")
              << "Caught an exception while constructing a file locator in InputFileCatalog::init: " << e.what()
              << "Skip this catalog";
        }
      }
      if (fileLocators_trivalCatalog_.empty()) {
        cms::Exception ex("FileCatalog");
        ex << "Unable to construct any file locator in InputFileCatalog::init";
        ex.addContext("Calling edm::InputFileCatalog::init()");
        throw ex;
      }
    } else if (catType == edm::CatalogType::RucioCatalog) {
      std::vector<edm::CatalogAttributes> const& tmp_dataCatalogs = localconfservice->dataCatalogs();
      if (!fileLocators_.empty())
        fileLocators_.clear();
      //Construct all file locators from data catalogs. If a data catalog is invalid (wrong protocol for example), it is skipped and no file locator is constructed (an exception is thrown out from FileLocator::init).
      for (const auto& catalog : tmp_dataCatalogs) {
        try {
          fileLocators_.push_back(std::make_unique<FileLocator>(catalog));
        } catch (cms::Exception const& e) {
          edm::LogWarning("InputFileCatalog")
              << "Caught an exception while constructing a file locator in InputFileCatalog::init: " << e.what()
              << "Skip this catalog";
        }
      }
      if (fileLocators_.empty()) {
        cms::Exception ex("FileCatalog");
        ex << "Unable to construct any file locator in InputFileCatalog::init";
        ex.addContext("Calling edm::InputFileCatalog::init()");
        throw ex;
      }
    } else {
      cms::Exception ex("FileCatalog");
      ex << "Undefined catalog type";
      ex.addContext("Calling edm::InputFileCatalog::init()");
      throw ex;
    }

    for (iter it = fileNames_.begin(), lt = logicalFileNames_.begin(), itEnd = fileNames_.end(); it != itEnd;
         ++it, ++lt) {
      boost::trim(*it);
      std::vector<std::string> pfns;
      if (it->empty()) {
        cms::Exception ex("FileCatalog");
        ex << "An empty string specified in the fileNames parameter for input source";
        ex.addContext("Calling edm::InputFileCatalog::init()");
        throw ex;
      }
      if (isPhysical(*it)) {
        if (it->back() == ':') {
          cms::Exception ex("FileCatalog");
          ex << "An empty physical file name specified in the fileNames parameter for input source";
          ex.addContext("Calling edm::InputFileCatalog::init()");
          throw ex;
        }
        pfns.push_back(*it);
        // Clear the LFN.
        lt->clear();
      } else {
        boost::trim(*lt);
        findFile(*lt, pfns, useLFNasPFNifLFNnotFound, catType);
      }

      fileCatalogItems_.push_back(FileCatalogItem(pfns, *lt));
    }
  }

isPhysical()

static bool edm::InputFileCatalog::isPhysical ( std::string const &  name )

inlinestatic

Definition at line 48 of file InputFileCatalog.h.

References Skims_PA_cff::name.

Referenced by init().

{ return (name.empty() || name.find(':') != std::string::npos); }

logicalFileNames()

std::vector<std::string> const& edm::InputFileCatalog::logicalFileNames ( ) const

inline

Definition at line 45 of file InputFileCatalog.h.

References logicalFileNames_.

Referenced by edm::FromFiles::logicalFileNames().

{ return logicalFileNames_; }

Member Data Documentation

fileCatalogItems_

std::vector<FileCatalogItem> edm::InputFileCatalog::fileCatalogItems_

private

Definition at line 58 of file InputFileCatalog.h.

Referenced by empty(), fileCatalogItems(), fileNames(), and init().

fileLocators_

std::vector<edm::propagate_const<std::unique_ptr<FileLocator> > > edm::InputFileCatalog::fileLocators_

private

Definition at line 62 of file InputFileCatalog.h.

Referenced by findFile(), and init().

fileLocators_trivalCatalog_

std::vector<edm::propagate_const<std::unique_ptr<FileLocator> > > edm::InputFileCatalog::fileLocators_trivalCatalog_

private

Definition at line 61 of file InputFileCatalog.h.

Referenced by findFile(), and init().

fileNames_

std::vector<std::string> edm::InputFileCatalog::fileNames_

private

Definition at line 57 of file InputFileCatalog.h.

Referenced by init().

logicalFileNames_

std::vector<std::string> edm::InputFileCatalog::logicalFileNames_

private

Definition at line 56 of file InputFileCatalog.h.

Referenced by init(), and logicalFileNames().

overrideFileLocator_

edm::propagate_const<std::unique_ptr<FileLocator> > edm::InputFileCatalog::overrideFileLocator_

private

Definition at line 59 of file InputFileCatalog.h.

Referenced by findFile(), and init().