JobOptionsSvc.cpp

Go to the documentation of this file.

// ============================================================================
// Local:
// ============================================================================
#include "JobOptionsSvc.h"
#include "Analyzer.h"
#include "Messages.h"
#include "Catalog.h"
#include "Units.h"
#include "PragmaOptions.h"
#include "Node.h"
#include "PythonConfig.h"
// ============================================================================
// Gaudi:
// ============================================================================
#include "GaudiKernel/IProperty.h"
#include "GaudiKernel/Property.h"

#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/System.h"
// ============================================================================
DECLARE_COMPONENT(JobOptionsSvc)
// ============================================================================
// Namespace aliases:
// ============================================================================
namespace gp = Gaudi::Parsers;
// ============================================================================
JobOptionsSvc::JobOptionsSvc(const std::string& name,ISvcLocator* svc):
  base_class(name,svc)
{
  m_pmgr.addRef(); // make sure the refCount doesn't go to zero too soon...
  std::string tmp ;
  tmp = System::getEnv ( "JOBOPTSEARCHPATH" ) ;
  if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dir_search_path = tmp ; }
  tmp = System::getEnv ( "JOBOPTSDUMPFILE"  ) ;
  if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dump = tmp ; }

  m_pmgr.declareProperty( "TYPE"       , m_source_type   ) ;
  m_pmgr.declareProperty( "PATH"       , m_source_path   ) ;
  m_pmgr.declareProperty( "SEARCHPATH" , m_dir_search_path ) ;
  m_pmgr.declareProperty( "DUMPFILE"   , m_dump          ) ;
  m_pmgr.declareProperty( "PYTHONACTION" , m_pythonAction  ) ;
  m_pmgr.declareProperty( "PYTHONPARAMS" , m_pythonParams  ) ;
}
// ============================================================================
StatusCode JobOptionsSvc::setProperty( const Property &p )
{
  return m_pmgr.setProperty( p );
}
// ============================================================================
StatusCode JobOptionsSvc::getProperty( Property *p ) const
{
  return m_pmgr.getProperty( p );
}
// ============================================================================
StatusCode JobOptionsSvc::initialize()
{
  // Call base class initializer
  StatusCode sc = Service::initialize();
  // Read the job options if needed
  if (sc) {
    if (m_source_type == "NONE") {
      return sc;
    } else if (m_source_type == "PYTHON") {
      PythonConfig conf(this);
      return conf.evaluateConfig(m_source_path, m_pythonParams, m_pythonAction);
    } else {
      return readOptions( m_source_path , m_dir_search_path);
    }
  }
  return sc;
}

// ============================================================================
StatusCode JobOptionsSvc::addPropertyToCatalogue
( const std::string& client,
  const Property& property )
{
  std::unique_ptr<Property> p { new StringProperty ( property.name(), "" ) } ;
  return property.load( *p ) ? m_svc_catalog.addProperty( client , p.release() )
                             : StatusCode::FAILURE ;
}
// ============================================================================
StatusCode
JobOptionsSvc::removePropertyFromCatalogue
( const std::string& client,
  const std::string& name )
{
  return m_svc_catalog.removeProperty(client,name);
}
// ============================================================================
const JobOptionsSvc::PropertiesT*
JobOptionsSvc::getProperties( const std::string& client) const
{
  return m_svc_catalog.getProperties(client);
}
// ============================================================================
StatusCode JobOptionsSvc::setMyProperties( const std::string& client,
                                           IProperty* myInt )
{
  const auto* props = m_svc_catalog.getProperties(client);
  if ( !props ){ return StatusCode::SUCCESS; }

  bool fail = false;
  for ( const auto& cur : *props )
  {
    StatusCode sc = myInt->setProperty ( *cur ) ;
    if ( sc.isFailure() )
    {
      MsgStream my_log( msgSvc(), name() );
      my_log
        << MSG::ERROR
        << "Unable to set the property '" << cur->name() << "'"
        <<                        " of '" << client         << "'. "
        << "Check option and algorithm names, type and bounds."
        << endmsg;
      fail = true;
    }
  }
  return fail ? StatusCode::FAILURE : StatusCode::SUCCESS ;
}

std::vector<std::string> JobOptionsSvc::getClients() const {
  return m_svc_catalog.getClients();
}


void JobOptionsSvc::dump (const std::string& file,
                          const gp::Catalog& catalog) const {
  MsgStream log ( msgSvc() , name() ) ;
  std::ofstream out( file , std::ios_base::out | std::ios_base::trunc );
  if ( !out ) {
    log << MSG::ERROR << "Unable to open dump-file \""+file+"\"" << endmsg ;
    return ;                                                   // RETURN
  }
  log << MSG::INFO << "Properties are dumped into \""+file+"\"" << endmsg ;
  // perform the actual dump:
  out << catalog;
}

void JobOptionsSvc::fillServiceCatalog(const gp::Catalog& catalog) {
  for (const auto&  client : catalog) {
    for (const auto& current : client.second ) {
      addPropertyToCatalogue ( client.first ,
                               StringProperty{ current.NameInClient(),
                                               current.ValueAsString() } );
    }
  }
}

StatusCode JobOptionsSvc::readOptions ( const std::string& file,
                                        const std::string& path) {
    std::string search_path = path;
    if ( search_path.empty() && !m_dir_search_path.empty() )
    { search_path =  m_dir_search_path ; }
    //
    MsgStream my_log( msgSvc(), name() );
    if (UNLIKELY(outputLevel() <= MSG::DEBUG))
      my_log << MSG::DEBUG                             // debug
             << "Reading options from the file "
             << "'" << file << "'" << endmsg;
    gp::Messages messages(my_log);
    gp::Catalog catalog;
    gp::Units units;
    gp::PragmaOptions pragma;
    gp::Node ast;
    StatusCode sc = gp::ReadOptions(file, path, &messages, &catalog, &units,
                                    &pragma, &ast);

    // --------------------------------------------------------------------------
    if ( sc.isSuccess() )
    {
      if (pragma.IsPrintOptions()) {
        my_log << MSG::INFO << "Print options" << std::endl << catalog
            << endmsg;
      }
      if (pragma.IsPrintTree()) {
        my_log << MSG::INFO << "Print tree:" << std::endl << ast.ToString()
            << endmsg;
      }
      if (pragma.HasDumpFile()) dump(pragma.dumpFile(), catalog);
      my_log << MSG::INFO
             << "Job options successfully read in from " << file << endmsg;
      fillServiceCatalog(catalog);
    } else {
      my_log << MSG::FATAL << "Job options errors."<< endmsg;
    }
    // ----------------------------------------------------------------------------
    return sc;
}