TDbiConfigStream.cxx

Go to the documentation of this file.

// $Id: TDbiConfigStream.cxx,v 1.1 2011/01/18 05:49:19 finch Exp $

#include <sstream>



#include "TDbiConfigStream.hxx"
#include "TDbiFieldType.hxx"
#include "TDbiTableProxy.hxx"
#include "TDbiDatabaseManager.hxx"
#include "TDbiWriter.hxx"
#include <TSK_DBI_Log.hxx>
#include <MsgFormat.h>
#include "TDbiRegistry.hxx"
#include "TDbiCfg.hxx"
#include "TDbiCascader.hxx"
using std::endl;
ClassImp(TDbiConfigStream)

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


TVldContext  TDbiConfigStream::fgDefaultContext(DbiDetector::kNear,
                                  DbiSimFlag::kData,
                                  TVldTimeStamp() );

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

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

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


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

//  None.


  SK_DBI_Debug( "Creating TDbiConfigStream" << "  ");
}

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

TDbiConfigStream::TDbiConfigStream(const string& SoftName,
                                 const std::string& ConfigName,
                                 TVldContext vc,
                                 TDbi::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: TDbi::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.


  SK_DBI_Debug( "Creating TDbiConfigStream" << "  ");

  // 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);
      SK_DBI_Log( "TDbiConfigStream for " << fSoftwName
                                 << "," << fConfigName
                                 << " has validity rec: " << fVRec
                                 << " and aggregate no.: " << fCFSet->GetAggregateNo()
                                 << "  ");
      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(&TDbiResultSetHandle<TDbiConfigSet>::GetTableProxy(tableName));
  TVldTimeStamp start(1970,1,1,0,0,0);
  TVldTimeStamp   end(2038,1,1,0,0,0);
  TVldRange vr(127,127,start,end,"TDbiConfigStream");
  fVRec.SetVldRange(vr);
  SK_DBI_Log( "TDbiConfigStream for " << fSoftwName
                             << "," << fConfigName
                             << " has no existing entry; creating validity rec: " << fVRec << "  ");

}

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

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


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

//  None.


  SK_DBI_Debug( "Destroying TDbiConfigStream" << "  ");

}

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


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

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

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

//  None.

  const TDbiConfigSet* cfSet = cfStream.GetConfigSet();

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

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

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

//  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 TDbiConfigSet 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 {
         SK_DBI_Severe( "Attempting to fill TDbiRegistry  from a table with "
                             << numParams << " columns (should be 3) using column named "
                             << fCFSet->GetParamName(2) << " (should be CONFIG_DATA)." << "  ");
    }
  }
  if ( keysLocked   ) reg->LockKeys();
  if ( valuesLocked ) reg->LockValues();
  return *this;
}
//.....................................................................

TDbiConfigStream& TDbiConfigStream::operator<<(const TDbiRegistry* reg) {
//
//
//  Purpose:  Stream configuration data from TDbiRegistry 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 == "" ) {
       SK_DBI_Severe( "Cannot fill (<<): No software name defined." << "  ");
    return *this;
  }

  TDbiFieldType stringType(TDbi::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 TDbiConfigStream::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 ) {
       SK_DBI_Severe( "No configuration data to write out." << "  ");
    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 ) {
    TDbiCascader& cas = TDbiDatabaseManager::Instance().GetCascader();
    Int_t aggNo = cas.AllocateSeqNo(fVRec.GetTableProxy()->GetTableName(),requireGlobal,dbNo);
    if ( aggNo <= TDbi::kMAXLOCALSEQNO && ! localTest ) {
         SK_DBI_Severe( "Cannot write out configuration data: no authorising entry in cascade." << "  ");
      return false;
    }
    fVRec.SetAggregateNo(aggNo);
    fCFSetModified.SetAggregateNo(aggNo);
    SK_DBI_Debug( "Aggregate number: " << aggNo
                      << " allocated to entry " << fSoftwName
                      << "," << fConfigName
                      << " in table " << fVRec.GetTableProxy()->GetTableName() << "  ");
  }
  TDbiWriter<TDbiConfigSet> writer(fVRec,dbNo,logComment);
  writer.SetRequireGlobalSeqno(requireGlobal);
  writer.SetOverlayCreationDate();
  writer << *fCFSet;
  return writer.Close();

}