DbiConfigStream.cxx

Go to the documentation of this file.

// $Id: DbiConfigStream.cxx,v 1.18 2006/10/11 08:25:54 west Exp $

#include <sstream>

#include "Configurable/Cfg.h"
#include "DatabaseInterface/DbiCascader.h"
#include "DatabaseInterface/DbiConfigStream.h"
#include "DatabaseInterface/DbiFieldType.h"
#include "DatabaseInterface/DbiTableProxy.h"
#include "DatabaseInterface/DbiTableProxyRegistry.h"
#include "DatabaseInterface/DbiWriter.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgService.h"
#include "Registry/Registry.h"

ClassImp(DbiConfigStream)

//   Definition of static data members
//   *********************************

CVSID("$Id: DbiConfigStream.cxx,v 1.18 2006/10/11 08:25:54 west Exp $");

VldContext  DbiConfigStream::fgDefaultContext(Detector::kNear,
                                  SimFlag::kData, 
                                  VldTimeStamp() );

//    Definition of all member functions (static or otherwise)
//    *******************************************************
//
//    -  ordered: ctors, dtor, operators then in alphabetical order.

//.....................................................................

DbiConfigStream::DbiConfigStream() :
fCFSet(0)
{
//
//
//  Purpose:  Default constructor
//
//  Arguments: None.  
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create dummy ConfigStream.


//  Program Notes:-
//  =============

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kDebug) << "Creating DbiConfigStream" << endl;
}

//.....................................................................

DbiConfigStream::DbiConfigStream(const string& SoftName,
                                 const std::string& ConfigName,
                                 VldContext vc,
                                 Dbi::Task task,
                                 const std::string& tableName) :
fCFSet(0),
fCFSetTable(tableName,vc,task),
fConfigName(ConfigName),
fSoftwName(SoftName)
{
//
//
//  Purpose:  Standard constructor
//
//  Arguments:  
//    SoftwName    in   Name of the software system to be configured
//    ConfigName   in   Name of the configuration set.  
//                        Default: "default"
//    vc           in   Context.  
//                        Default: Dbi::fgDefaultContext.
//    task         in   The task of the configuration. 
//                        Default: 0
//    tableName    in   Name of configuration data table. 
//                        Default: "SOFTWARE_CONFIGURATION"
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create ConfigStream from specified table.


//  Program Notes:-
//  =============

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kDebug) << "Creating DbiConfigStream" << endl;

  // Search for row matching software and configuration names.
  int rowNum = fCFSetTable.GetNumRows()-1;
  while ( rowNum >= 0 ) {
    fCFSet = fCFSetTable.GetRow(rowNum);
    if (    fCFSet->GetParamValue(0) == fSoftwName
         && fCFSet->GetParamValue(1) == fConfigName ) {
      fVRec = *fCFSetTable.GetValidityRec(fCFSet);
      MSG("Dbi", Msg::kSynopsis) << "DbiConfigStream for " << fSoftwName
                                 << "," << fConfigName
                                 << " has validity rec: " << fVRec 
                                 << " and aggregate no.: " << fCFSet->GetAggregateNo()
                                 << endl;
      return;
    }
    --rowNum;
  }

  // Cannot find matching row, leave configuration data as null
  // and set up a validity rec that can be used if creating a
  // new row.

  fCFSet = 0;

  fVRec.SetDbNo(0);
  fVRec.SetTableProxy(&DbiResultPtr<DbiConfigSet>::GetTableProxy(tableName));
  VldTimeStamp start(1970,1,1,0,0,0);
  VldTimeStamp   end(2038,1,1,0,0,0);
  VldRange vr(127,127,start,end,"DbiConfigStream");
  fVRec.SetVldRange(vr);
  MSG("Dbi", Msg::kSynopsis) << "DbiConfigStream for " << fSoftwName
                             << "," << fConfigName
                             << " has no existing entry; creating validity rec: " << fVRec << endl;

}

//.....................................................................

DbiConfigStream::~DbiConfigStream() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy ConfigStream.


//  Program Notes:-
//  =============

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbi", Msg::kDebug) << "Destroying DbiConfigStream" << endl;

}

//.....................................................................


  ostream& operator<<(ostream& os, const DbiConfigStream& cfStream) {

//
//
//  Purpose:  Output status of DbiConfigStream on ostream.
//
//  Arguments: 
//    os           in    ostream to be outout
//    cfStream     in    DbiConfigStream whise status is to be output.
//
//  Return:    Updated ostream
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Output status of DbiConfigStream on ostream.

//  Program Notes:-
//  =============

//  None.

  const DbiConfigSet* cfSet = cfStream.GetConfigSet();

  if ( cfSet )  os << "DbiConfigSet contains: " << *cfSet << endl;
  else          os << "DbiConfigSet is empty! " << endl;
  return os;
}

//.....................................................................

const DbiConfigStream& DbiConfigStream::operator>>(Registry* reg) {
//
//
//  Purpose:  Stream configuration data into Registry object.
//
//  Arguments: 
//    reg          in    Empty Registry object (contents ignored)
//                 out   Filled Registry object.
//
//  Return:    Original DbiConfigStream object.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Erase the contents of reg and refill from the DbiConfigSet
//    owned by this DbiConfigStream.

//  Program Notes:-
//  =============

//  None.

  if ( ! reg ) return *this;
   
//  Record the current state of reg and then clear it.

  Bool_t keysLocked   = reg->KeysLocked();
  Bool_t valuesLocked = reg->ValuesLocked();
  reg->UnLockKeys();
  reg->UnLockValues();
  reg->Clear();

//  Use the owned DbiConfigSet to fill reg.

  if ( fCFSet ) {
    UInt_t numParams = fCFSet->GetNumParams();

//  Handle configuration tables.

    if ( numParams == 3 && fCFSet->GetParamName(2) == "CONFIG_DATA" ) {
      istringstream is(fCFSet->GetParamValue(2));
      reg->ReadStream(is);
    }
    else {
      MAXMSG("Dbi",Msg::kError,20) << "Attempting to fill Registry  from a table with "
                             << numParams << " columns (should be 3) using column named "
                             << fCFSet->GetParamName(2) << " (should be CONFIG_DATA)." << endl;
    }
  }
  if ( keysLocked   ) reg->LockKeys();
  if ( valuesLocked ) reg->LockValues();
  return *this;
}
//.....................................................................

DbiConfigStream& DbiConfigStream::operator<<(const Registry* reg) {
//
//
//  Purpose:  Stream configuration data from Registry object.
//
//  Arguments: 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Refill internal fCFSetModified from reg..

//  Program Notes:-
//  =============

//  This does NOT write to the database.  To do that first use this
//  method to refill the configuration and then call the Write method.

  if ( fSoftwName == "" ) {
    MAXMSG("Dbi",Msg::kError,20) << "Cannot fill (<<): No software name defined." << endl;
    return *this;
  }

  DbiFieldType stringType(Dbi::kString);

  ostringstream os;
  reg->PrintStream(os);
  fCFSetModified.Clear();
  fCFSetModified.PushBack("SOFTW_NAME", fSoftwName,  stringType);
  fCFSetModified.PushBack("CONFIG_NAME",fConfigName, stringType);
  fCFSetModified.PushBack("CONFIG_DATA",os.str(),    stringType);
  if ( fVRec.GetAggregateNo() > 0 ) fCFSetModified.SetAggregateNo( fVRec.GetAggregateNo());
  fCFSet =  &fCFSetModified; 
  return *this;

}


//.....................................................................

Bool_t DbiConfigStream::Write(UInt_t dbNo,
                              const std::string& logComment,
                              Bool_t localTest ) {
//
//
//  Purpose:  Write configuration data to the database.
//
//  Arguments: 
//    dbNo         in    Database number in cascade (starting at 0).
//                         Default: 0.
//    logComment   in    Reason for update.
//                         Default: "".
//    localTest    in    Set true to use local SEQNOs (doesn't require authorising DB).
//                         Default: false.
//
//  Return:        True if I/O successful.

  if ( ! fCFSet ) {
    MAXMSG("Dbi",Msg::kError,20) << "No configuration data to write out." << endl;
    return false;
  }

  // If no aggregate number has been asigned so far, but fCFSet non-zero, then must
  // be creating a new software/config combination with the data in fCFSetModified.
  // Use a global seqno number (or local if localTest) to define a unique aggregate number.
  int requireGlobal = localTest ? -1 : 1;
  if ( fVRec.GetAggregateNo() < 0 ) {
    DbiCascader& cas = DbiTableProxyRegistry::Instance().GetCascader();
    Int_t aggNo = cas.AllocateSeqNo(fVRec.GetTableProxy()->GetTableName(),requireGlobal,dbNo);
    if ( aggNo <= Dbi::kMAXLOCALSEQNO && ! localTest ) {
      MAXMSG("Dbi",Msg::kError,20) << "Cannot write out configuration data: no authorising entry in cascade." << endl;
      return false;
    }
    fVRec.SetAggregateNo(aggNo);
    fCFSetModified.SetAggregateNo(aggNo);
    MSG("Dbi",Msg::kDebug) << "Aggregate number: " << aggNo 
                      << " allocated to entry " << fSoftwName
                      << "," << fConfigName
                      << " in table " << fVRec.GetTableProxy()->GetTableName() << endl;
  }
  DbiWriter<DbiConfigSet> writer(fVRec,dbNo,logComment);
  writer.SetRequireGlobalSeqno(requireGlobal);
  writer.SetOverlayCreationDate();
  writer << *fCFSet;
  return writer.Close();

}

---