PersistencySvc.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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 "PersistencySvc.h"
#include <GaudiKernel/DataObject.h>
#include <GaudiKernel/IConverter.h>
#include <GaudiKernel/IDataProviderSvc.h>
#include <GaudiKernel/IDataSelector.h>
#include <GaudiKernel/IOpaqueAddress.h>
#include <GaudiKernel/ISvcLocator.h>
#include <GaudiKernel/MsgStream.h>
#include <GaudiKernel/SmartIF.h>
#include <GaudiKernel/TypeNameString.h>
 
#include <strings.h>
 
DECLARE_COMPONENT( PersistencySvc )
 
enum CnvSvcAction {
  CREATE_OBJ,
  FILL_OBJ_REFS,
  UPDATE_OBJ,
  UPDATE_OBJ_REFS,
  CREATE_REP,
  FILL_REP_REFS,
  UPDATE_REP,
  UPDATE_REP_REFS
};
 
StatusCode PersistencySvc::makeCall( int typ, IOpaqueAddress*& pAddress, DataObject*& pObject ) {
  if ( m_enable ) {
    IConversionSvc* svc = nullptr;
    switch ( typ ) {
    case CREATE_REP:
    case FILL_REP_REFS:
    case UPDATE_REP:
    case UPDATE_REP_REFS:
      svc = m_cnvDefault;
      break;
    default:
      if ( !pAddress ) return Status::INVALID_ADDRESS;
      svc = service( pAddress->svcType() );
      if ( !svc ) return Status::BAD_STORAGE_TYPE;
      break;
    }
 
    StatusCode status = StatusCode::FAILURE;
    switch ( typ ) {
    case CREATE_OBJ:
      pObject = nullptr;
      status  = svc->createObj( pAddress, pObject );
      break;
    case FILL_OBJ_REFS:
      status = svc->fillObjRefs( pAddress, pObject );
      break;
    case UPDATE_OBJ:
      status = svc->updateObj( pAddress, pObject );
      break;
    case UPDATE_OBJ_REFS:
      status = svc->updateObjRefs( pAddress, pObject );
      break;
    case CREATE_REP:
      status = svc->createRep( pObject, pAddress );
      break;
    case FILL_REP_REFS:
      status = svc->fillRepRefs( pAddress, pObject );
      break;
    case UPDATE_REP:
      status = svc->updateRep( pAddress, pObject );
      break;
    case UPDATE_REP_REFS:
      status = svc->updateRepRefs( pAddress, pObject );
      break;
    default:
      status = StatusCode::FAILURE;
      break;
    }
    status.ignore();
    return status;
  }
  return StatusCode::SUCCESS;
}

StatusCode PersistencySvc::createObj( IOpaqueAddress* pAddr, DataObject*& refpObj ) {
  return makeCall( CREATE_OBJ, pAddr, refpObj );
}

StatusCode PersistencySvc::fillObjRefs( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( FILL_OBJ_REFS, pAddr, pObj );
}

StatusCode PersistencySvc::updateObj( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( UPDATE_OBJ, pAddr, pObj );
}

StatusCode PersistencySvc::updateObjRefs( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( UPDATE_OBJ_REFS, pAddr, pObj );
}

StatusCode PersistencySvc::createRep( DataObject* pObj, IOpaqueAddress*& refpAddr ) {
  return makeCall( CREATE_REP, refpAddr, pObj );
}

StatusCode PersistencySvc::fillRepRefs( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( FILL_REP_REFS, pAddr, pObj );
}

StatusCode PersistencySvc::updateRep( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( UPDATE_REP, pAddr, pObj );
}

StatusCode PersistencySvc::updateRepRefs( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return makeCall( UPDATE_REP_REFS, pAddr, pObj );
}

SmartIF<IAddressCreator>& PersistencySvc::addressCreator( long type ) {
  std::scoped_lock _{ m_servicesMutex };
 
  long typ = type;
  auto it  = m_cnvServices.find( typ );
  if ( it == m_cnvServices.end() ) {
    IConversionSvc* s = service( type );
    if ( s ) {
      it = m_cnvServices.find( typ );
      if ( it != m_cnvServices.end() ) return it->second.addrCreator();
    }
    static SmartIF<IAddressCreator> no_creator;
    return no_creator;
  }
  return it->second.addrCreator();
}

StatusCode PersistencySvc::setDataProvider( IDataProviderSvc* pDataSvc ) {
  std::scoped_lock _{ m_servicesMutex };
  m_dataSvc = pDataSvc;
  for ( auto& i : m_cnvServices ) { i.second.conversionSvc()->setDataProvider( m_dataSvc ).ignore(); }
  return StatusCode::SUCCESS;
}

SmartIF<IDataProviderSvc>& PersistencySvc::dataProvider() const { return m_dataSvc; }

StatusCode PersistencySvc::setConversionSvc( IConversionSvc* svc ) {
  m_cnvDefault = svc;
  return StatusCode::SUCCESS;
}

SmartIF<IConversionSvc>& PersistencySvc::conversionSvc() const { return m_cnvDefault; }

StatusCode PersistencySvc::addConverter( const CLID& /* clid */ ) { return StatusCode::FAILURE; }

StatusCode PersistencySvc::addConverter( IConverter* pConverter ) {
  if ( !pConverter ) return Status::NO_CONVERTER;
  IConversionSvc* svc = service( pConverter->repSvcType() );
  return svc ? svc->addConverter( pConverter ) : Status::BAD_STORAGE_TYPE;
}

StatusCode PersistencySvc::removeConverter( const CLID& clid ) {
  std::scoped_lock _{ m_servicesMutex };
  // Remove converter type from all services
  StatusCode status = Status::NO_CONVERTER, iret = StatusCode::SUCCESS;
  for ( auto& i : m_cnvServices ) {
    iret = i.second.conversionSvc()->removeConverter( clid );
    if ( iret.isSuccess() ) status = iret;
  }
  return status;
}

IConverter* PersistencySvc::converter( const CLID& /*clid*/ ) { return nullptr; }

SmartIF<IConversionSvc>& PersistencySvc::service( const std::string& nam ) {
  Gaudi::Utils::TypeNameString tn( nam );
 
  std::scoped_lock _{ m_servicesMutex };
 
  auto it = std::find_if( m_cnvServices.begin(), m_cnvServices.end(),
                          [&]( Services::const_reference i ) { return i.second.service()->name() == tn.name(); } );
  if ( it != m_cnvServices.end() ) return it->second.conversionSvc();
 
  auto svc = Service::service<IConversionSvc>( nam, true );
  if ( svc && addCnvService( svc.get() ).isSuccess() ) {
    return service( nam ); // now it is in the list
  }
 
  error() << "Cannot access Conversion service " << nam << endmsg;
  static SmartIF<IConversionSvc> no_svc;
  return no_svc;
}

SmartIF<IConversionSvc>& PersistencySvc::service( long type ) {
  std::scoped_lock _{ m_servicesMutex };
  // Check wether this is already an active service
  auto it = m_cnvServices.find( type );
  if ( it != m_cnvServices.end() ) return it->second.conversionSvc();
  // if not, check if the service is in the list and may be requested
  for ( const auto& i : m_svcNames.value() ) {
    auto& svc = service( i );
    if ( svc && svc->repSvcType() == type ) return svc;
  }
  static SmartIF<IConversionSvc> no_svc;
  return no_svc;
}

StatusCode PersistencySvc::addCnvService( IConversionSvc* servc ) {
  std::scoped_lock _{ m_servicesMutex };
  if ( !servc ) return Status::BAD_STORAGE_TYPE;
  long type    = servc->repSvcType();
  long def_typ = ( m_cnvDefault ? m_cnvDefault->repSvcType() : 0 );
  auto it      = m_cnvServices.find( type );
  auto cnv_svc = ( it != m_cnvServices.end() ? it->second.conversionSvc() : nullptr );
  if ( type == def_typ ) m_cnvDefault = servc;
  if ( cnv_svc == servc ) return StatusCode::SUCCESS;
 
  auto iservc = make_SmartIF( servc );
  auto icr    = iservc.as<IAddressCreator>();
  if ( icr ) {
    auto isvc = iservc.as<IService>();
    if ( isvc ) {
      if ( cnv_svc ) removeCnvService( type ).ignore();
      auto p = m_cnvServices.emplace( type, ServiceEntry( type, isvc, iservc, icr ) );
      if ( !p.second ) {
        error() << "Cannot add Conversion service " << isvc->name() << endmsg;
        return StatusCode::FAILURE;
      }
      info() << "Added successfully Conversion service " << isvc->name() << endmsg;
      iservc->setAddressCreator( this ).ignore();
      iservc->setDataProvider( m_dataSvc ).ignore();
      return StatusCode::SUCCESS;
    }
  }
  error() << "Cannot add Conversion service for type " << type << endmsg;
  return StatusCode::FAILURE;
}

StatusCode PersistencySvc::removeCnvService( long svctype ) {
  std::scoped_lock _{ m_servicesMutex };
 
  auto it = m_cnvServices.find( svctype );
  if ( it == m_cnvServices.end() ) return Status::BAD_STORAGE_TYPE;
  it->second.service()->release();
  it->second.addrCreator()->release();
  m_cnvServices.erase( it );
  return StatusCode::SUCCESS;
}

long PersistencySvc::repSvcType() const { return m_cnvDefault ? m_cnvDefault->repSvcType() : 0; }

StatusCode PersistencySvc::setDefaultCnvService( long type ) {
  m_cnvDefault = service( type );
  return StatusCode::SUCCESS;
}

StatusCode PersistencySvc::connectOutput( const std::string& outputFile, const std::string& /* openMode */ ) {
  return connectOutput( outputFile );
}

StatusCode PersistencySvc::connectOutput( const std::string& ) { return StatusCode::SUCCESS; }

StatusCode PersistencySvc::commitOutput( const std::string&, bool ) { return StatusCode::SUCCESS; }

StatusCode PersistencySvc::createAddress( long svc_type, const CLID& clid, const std::string* pars,
                                          const unsigned long* ipars, IOpaqueAddress*& refpAddress ) {
  refpAddress          = nullptr;
  IAddressCreator* svc = addressCreator( svc_type );
  return svc ? svc->createAddress( svc_type, clid, pars, ipars, refpAddress ) : Status::BAD_STORAGE_TYPE;
}

StatusCode PersistencySvc::convertAddress( const IOpaqueAddress* pAddress, std::string& refAddress ) {
  // Assumption is that the Persistency service prepends a header
  // and requests the conversion service referred to by the service
  // type to encode the rest
  long svc_type = 0;
  CLID clid     = 0;
  if ( pAddress ) {
    svc_type = pAddress->svcType();
    clid     = pAddress->clID();
  }
  IAddressCreator* svc    = addressCreator( svc_type );
  StatusCode       status = Status::BAD_STORAGE_TYPE; // Preset error
  refAddress.clear();
 
  if ( svc ) {
    // Found service, set header
    encodeAddrHdr( svc_type, clid, refAddress );
    std::string address;
    // Get rest of address from conversion service
    status = svc->convertAddress( pAddress, address );
    refAddress += address;
  }
  return status;
}

StatusCode PersistencySvc::createAddress( long /* svc_type */, const CLID& /* clid */, const std::string& refAddress,
                                          IOpaqueAddress*& refpAddress ) {
  // Assumption is that the Persistency service decodes that header
  // and requests the conversion service referred to by the service
  // type to decode the rest
  long        new_svc_type = 0;
  CLID        new_clid     = 0;
  std::string address_trailer;
  decodeAddrHdr( refAddress, new_svc_type, new_clid, address_trailer );
  IAddressCreator* svc = addressCreator( new_svc_type );
  return svc ? svc->createAddress( new_svc_type, new_clid, address_trailer, refpAddress ) : Status::BAD_STORAGE_TYPE;
}

void PersistencySvc::encodeAddrHdr( long service_type, const CLID& clid, std::string& address ) const {
  // For address header, use xml-style format of
  // <addrhdr service_type="xxx" clid="yyy" />
  std::stringstream stream;
  int               svctyp = service_type; // must put int into stream, not char
  stream << "<address_header service_type=\"" << svctyp << "\" clid=\"" << clid << "\" /> ";
  address = stream.str();
}

void PersistencySvc::decodeAddrHdr( const std::string& address, long& service_type, CLID& clid,
                                    std::string& address_trailer ) const {
  // For address header, use xml-style format of
  // <address_header service_type="xxx" clid="yyy" />
  service_type = 0;
  clid         = 0;
  address_trailer.clear();
 
  // Check for address_header tag
  size_t pos = address.find( "<address_header" );
  if ( std::string::npos != pos ) {
    // Get service_type
    pos = address.find( "service_type=\"" );
    if ( std::string::npos != pos ) {
      pos += 14;
      size_t end = address.find( '"', pos );
      if ( std::string::npos != end ) {
        service_type = std::stol( address.substr( pos, end - pos ) );
        // Get clid
        pos = address.find( "clid=\"" );
        if ( std::string::npos != pos ) {
          pos += 6;
          end = address.find( '\"', pos );
          if ( std::string::npos != end ) {
            std::istringstream str;
            str.str( address.substr( pos, end - pos ) );
            str >> clid;
            // Get trailer_address
            pos = address.find( '>' );
            if ( pos < ( address.size() - 2 ) ) { // this means that '>' was found (pos != npos)
                                                  // it is before the last char
              address_trailer = address.substr( pos + 1 );
            }
          }
        }
      }
    }
  }
}

StatusCode PersistencySvc::setAddressCreator( IAddressCreator* ) {
  // The persistency service is an address creation dispatcher itself.
  // The persistency service can NEVER create addresses itself.
  // The entry point must only be provided in order to fulfill the needs of the
  // implementing interfaces.
  return StatusCode::FAILURE;
}

SmartIF<IAddressCreator>& PersistencySvc::addressCreator() const { return m_addrCreator; }

StatusCode PersistencySvc::getService( long service_type, IConversionSvc*& refpSvc ) {
  refpSvc = service( service_type );
  return refpSvc ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

StatusCode PersistencySvc::getService( const std::string& service_type, IConversionSvc*& refpSvc ) {
  const char* imp = service_type.c_str();
  long        len = service_type.length();
  if ( ::strncasecmp( imp, "SICB", len ) == 0 )
    return getService( SICB_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "ZEBRA", len ) == 0 )
    return getService( SICB_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "MS Access", len ) == 0 )
    return getService( ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Microsoft Access", strlen( "Microsoft Access" ) ) == 0 )
    return getService( ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "SQL Server", len ) == 0 )
    return getService( SQLSERVER_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Microsoft ODBC for Oracle", len ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Oracle ODBC", strlen( "Oracle ODBC" ) ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Oracle OCI", strlen( "Oracle OCI" ) ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "MySQL", len ) == 0 )
    return getService( MYSQL_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "ROOT", len ) == 0 )
    return getService( ROOT_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "OBJY", len ) == 0 )
    return getService( OBJY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "OBJYECTI", 7 ) == 0 )
    return getService( OBJY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOTKEY", 12 ) == 0 )
    return getService( POOL_ROOTKEY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOTTREE", 12 ) == 0 )
    return getService( POOL_ROOTTREE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOT", 9 ) == 0 )
    return getService( POOL_ROOT_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_MySQL", 8 ) == 0 )
    return getService( POOL_MYSQL_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ORACLE", 8 ) == 0 )
    return getService( POOL_ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ACCESS", 8 ) == 0 )
    return getService( POOL_ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL", 4 ) == 0 )
    return getService( POOL_StorageType, refpSvc );
 
  std::scoped_lock _{ m_servicesMutex };
  for ( const auto& i : m_cnvServices ) {
    SmartIF<IService> svc( i.second.conversionSvc() );
    if ( svc ) {
      // Check wether this is already an active service: first check by service name
      if ( svc->name() == service_type ) {
        refpSvc = i.second.conversionSvc();
        return StatusCode::SUCCESS;
      }
      // Check wether this is already an active service: now check by service type
      auto instance = svc.get();
      if ( System::typeinfoName( typeid( *instance ) ) == service_type ) {
        refpSvc = i.second.conversionSvc();
        return StatusCode::SUCCESS;
      }
    }
  }
  // if not, check if the service is in the list and may be requested
  for ( const auto& i : m_svcNames.value() ) {
    Gaudi::Utils::TypeNameString itm( i );
    if ( itm.name() == service_type || itm.type() == service_type ) {
      IConversionSvc* svc = service( i );
      if ( svc ) {
        refpSvc = svc;
        return StatusCode::SUCCESS;
      }
    }
  }
  return StatusCode::FAILURE;
}

const CLID& PersistencySvc::objType() const { return CLID_NULL; }

StatusCode PersistencySvc::initialize() {
  m_addrCreator = this; // initialize internal pointer to IAddressCreator interface
  // Initialize basic service
  StatusCode status = Service::initialize();
  if ( !status.isSuccess() ) { error() << "Error initializing Service base class." << endmsg; }
  return status;
}

StatusCode PersistencySvc::finalize() {
  std::scoped_lock _{ m_servicesMutex };
  // Release all workers
  m_cnvServices.clear();
  // Release references to this to avoid loops
  m_addrCreator = nullptr;
  return StatusCode::SUCCESS;
}

bool PersistencySvc::enable( bool value ) {
  std::swap( value, m_enable );
  return value;
}