FileSvc.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 2024-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#include <Gaudi/Interfaces/IFileSvc.h>
#include <Gaudi/Parsers/Factory.h>
#include <GaudiKernel/DataIncident.h>
#include <GaudiKernel/IIncidentSvc.h>
#include <GaudiKernel/Service.h>
#include <GaudiKernel/StatusCode.h>
#include <TFile.h>
#include <boost/algorithm/string.hpp>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <vector>

class FileSvc : public extends<Service, Gaudi::Interfaces::IFileSvc> {
public:
  // Constructor
  FileSvc( const std::string& name, ISvcLocator* svc );
 
  StatusCode initialize() override;
 
  StatusCode finalize() override;

  std::shared_ptr<TFile> getFile( const std::string& identifier ) override;

  bool hasIdentifier( const std::string& identifier ) const override;
 
public:
  // See FileSvc documentation for the syntax supported for paths
  Gaudi::Property<std::map<std::string, std::string>> m_config{
      this, "Config", {}, "Map of keywords to file paths for file access" };
 
private:
  std::shared_ptr<TFile> openFile( const std::string& filePath, const std::string& option, int compress );

  StatusCode closeFiles();
 
private:
  // Map holding file identifiers to file indices in the m_files vector
  std::unordered_map<std::string, size_t> m_identifiers;
 
  // Vector to hold all files unique pointers
  std::vector<std::shared_ptr<TFile>> m_files;
};
 
DECLARE_COMPONENT( FileSvc )
 
namespace {
  std::map<std::string, std::string> parseFilePath( const std::string& path ) {
    std::vector<std::string> parts;
    boost::split( parts, path, boost::is_any_of( "?" ) );
    std::map<std::string, std::string> result;
    if ( parts.size() > 1 ) {
      std::vector<std::string> params;
      boost::split( params, parts[1], boost::is_any_of( "&" ) );
      for ( auto& param : params ) {
        std::vector<std::string> kv;
        boost::split( kv, param, boost::is_any_of( "=" ) );
        if ( kv.size() == 2 ) { result[boost::trim_copy( kv[0] )] = boost::trim_copy( kv[1] ); }
      }
    }
    result["mode"] = ( result.find( "mode" ) == result.end() ) ? "CREATE" : result["mode"];
    result["path"] = boost::trim_copy( parts[0] );
    return result;
  }

  StatusCode checkConfig( const std::map<std::string, std::string>& configMap, const FileSvc& svc ) {
    std::map<std::string, std::map<std::string, std::string>> fileParams;
    for ( const auto& [identifier, path] : configMap ) {
      auto params = parseFilePath( path );
 
      auto& existingParams = fileParams[params["path"]];
      if ( !existingParams.empty() ) {
        if ( existingParams != params ) {
          svc.error() << "Conflicting configurations for file path: " << params["path"] << endmsg;
          return StatusCode::FAILURE;
        }
      } else {
        existingParams = std::move( params );
      }
    }
    return StatusCode::SUCCESS;
  }

  std::optional<size_t> findFileIndex( const std::vector<std::shared_ptr<TFile>>& files, const std::string& filePath ) {
    auto it = std::find_if( files.begin(), files.end(),
                            [&filePath]( const auto& file ) { return file && file->GetName() == filePath; } );
    if ( it != files.end() ) { return std::distance( files.begin(), it ); }
    return std::nullopt;
  }
} // namespace
 
FileSvc::FileSvc( const std::string& name, ISvcLocator* svc ) : base_class( name, svc ) {}
 
StatusCode FileSvc::initialize() {
  return Service::initialize().andThen( [this]() {
    auto incidentSvc = service<IIncidentSvc>( "IncidentSvc", false );
 
    if ( checkConfig( m_config, *this ).isFailure() ) { return StatusCode::FAILURE; }
 
    for ( const auto& [identifier, path] : m_config ) {
      auto params = parseFilePath( path );
 
      // Check if this file is already opened and mapped
      if ( auto fileIndex = findFileIndex( m_files, params["path"] ) ) {
        // File already opened, just map the identifier to the existing index
        m_identifiers[boost::to_lower_copy( identifier )] = *fileIndex;
      } else {
        // File not found, open a new one
        int compress = ( params.find( "compress" ) != params.end() )
                           ? std::stoi( params["compress"] )
                           : ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault;
        if ( auto file = openFile( path, params["mode"], compress ) ) {
          m_files.push_back( std::move( file ) );
          m_identifiers[boost::to_lower_copy( identifier )] = m_files.size() - 1;
          auto* outputFile                                  = m_files.back().get();
          if ( incidentSvc ) {
            incidentSvc->fireIncident(
                ContextIncident<TFile*>( outputFile->GetName(), "CONNECTED_OUTPUT", outputFile ) );
          }
        } else {
          error() << "Failed to open file: " << params["path"] << endmsg;
          return StatusCode::FAILURE;
        }
      }
    }
 
    return StatusCode::SUCCESS;
  } );
}
 
StatusCode FileSvc::finalize() { return closeFiles(); }
 
std::shared_ptr<TFile> FileSvc::getFile( const std::string& identifier ) {
  auto it = m_identifiers.find( boost::to_lower_copy( identifier ) );
  if ( it != m_identifiers.end() && it->second < m_files.size() ) { return m_files[it->second]; }
  error() << "No file associated with identifier: " << identifier << endmsg;
  return nullptr;
}
 
bool FileSvc::hasIdentifier( const std::string& identifier ) const {
  return m_identifiers.find( boost::to_lower_copy( identifier ) ) != m_identifiers.end();
}
 
std::shared_ptr<TFile> FileSvc::openFile( const std::string& filePath, const std::string& option, int compress ) {
  auto file = std::make_shared<TFile>( filePath.c_str(), option.c_str(), "", compress );
  if ( !file || file->IsZombie() ) { return nullptr; }
  return file;
}
 
StatusCode FileSvc::closeFiles() {
  for ( const auto& file : m_files ) {
    if ( file ) { file->Close(); }
  }
  m_files.clear();
  m_identifiers.clear();
  return StatusCode::SUCCESS;
}