DbmLogFile.cxx

Go to the documentation of this file.

// DbmLogFile                                                         //
//                                                                    //
// Package: Dbm (Database Maintenance).                               //
//                                                                    //
// N. West 12/2001                                                    //
//                                                                    //
// Concept: Archive of import/export transactions.                    //
//                                                                    //
// Purpose: To record transactions and provide context for successive //
//          exports.                                                  //
//                                                                    //

#include <algorithm>
#include <cctype>
#include <iomanip>
#include <sstream>

#include "DatabaseMaintenance/DbmCmdOptions.h"
#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiLogEntry.h"
#include "DatabaseInterface/DbiResultPtr.h"
#include "DatabaseInterface/DbiTableProxy.h"
#include "DatabaseInterface/DbiValidityRec.h"
#include "DatabaseMaintenance/DbmLogFile.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgService.h"
#include "Validity/VldTimeStamp.h"

ClassImp(DbmLogFile)


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

CVSID("$Id: DbmLogFile.cxx,v 1.15 2008/06/13 12:40:30 nwest Exp $");

// Definition of member functions (alphabetical order)
// ***************************************************


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

DbmLogFile::DbmLogFile(const string& fileName,UInt_t dbNo) :
fDbNo(dbNo),
fLogFile(0)
{
//
//  Purpose:  Default constructor
//
//  Arguments:
//     fileName  in  File name.  Default = "". 
//     dbNo      in  Database no.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Create a DbmLogFile.


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

//  None.

  LEA_CTOR    //Leak Checker
  MSG("Dbm", Msg::kVerbose) << "Creating DbmLogFile" << endl;

  if ( fileName == "") return;
  
  fLogFile = new ofstream(fileName.c_str(),ios::app);
  if ( ! fLogFile->is_open() ) {
    MSG("Dbm",Msg::kError) << "Cannot open " << fileName << endl;
    return;
  }    
}

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

DbmLogFile::~DbmLogFile() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Complete last LogRec (if any) and Destroy DbmLogFile.


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

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbm", Msg::kVerbose) << "Destroying DbmLogFile" << endl;

  LogRec(0);
  delete fLogFile;
  fLogFile = 0;

}

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

void DbmLogFile::LogCmd(const string& cmd,
                        const DbmCmdOptions& opts)  {
//
//
//  Purpose:  Record command plus options into the log.
//
//  Arguments: 
//    cmd          in    The command to be executed.
//    opts          in   The options for the current command.
//
//  Return:    n/a.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Record command plus options into the log.

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

//  None.

  if ( ! IsValid() ) return;
  //Skip a line.
  this->LogMsg("",kFALSE);
  string msg(cmd);
  msg += " ";
  msg += opts.GetOpts();

  // Tidy up command by placing each option on a new line.
  string insert("+\n      ");
  UInt_t locOpt = 0;
  while (  (locOpt = msg.find("--",locOpt)) != string::npos ) {
    msg.insert(locOpt,insert);
    locOpt += insert.size() + 2;
  }
  this->LogMsg(msg);
  return;
  
  
}
//.....................................................................

void DbmLogFile::LogMsg(const string& msg,
                        Bool_t addDateStamp)  {
//
//
//  Purpose:  Record date-stamped message  into the log.
//
//  Arguments: 
//    msg          in    The message to be recorded.
//    addDateStamp in    If true (default) prefix date stamp.
//
//  Contact:   N. West

  if ( ! IsValid() ) return;
  if ( addDateStamp ) {
    VldTimeStamp now;
    (*fLogFile) << Dbi::MakeDateTimeString( now )
              << " ";
  }
  (*fLogFile) << msg <<  endl;

  return;
  
  
}
//.....................................................................

void DbmLogFile::LogRec(const DbiValidityRec* vrec ) {
//
//
//  Purpose:  Record DbiValidityRec I/O into the log.
//
//  Arguments: 
//    vrec         in    The DbiValidityRec to be recorded.
//                       May be zero (just to flush out last log 
//                       summary).
//
//  Return:    None.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Record summary of DbiValidityRec I/O into the log.

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

//  None.

  if ( ! IsValid() ) return;
  string tableName =  vrec ? vrec->GetTableProxy()->GetTableName() : "";
  UInt_t seqNo =  vrec ? vrec->GetSeqNo() : 0;  
  LogRec(tableName,seqNo);

}
//.....................................................................

void DbmLogFile::LogRec(const string tableName, UInt_t seqNo) {
//
//
//  Purpose:  Record DbiValidityRec I/O into the log.
//
//  Arguments: 
//    tableName    in    Table name to be logged.. May be null (just to 
//                         Flush out last log summary).
//    seqNo        in    SeqNo to be logged.
//
//  Return:    None.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Record summary of DbiValidityRec I/O into the log.

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

//  None.

  if ( ! IsValid() ) return;
  
//  If there is a change of table name output any buffered log info.
  if ( tableName != fLogTableName ) {
    if ( fLogDBSrcNos.size() ) {
      list<UInt_t>::const_iterator itr    = fLogDBSrcNos.begin();
      list<UInt_t>::const_iterator itrEnd = fLogDBSrcNos.end();
      while ( itr != itrEnd ) {
        UInt_t dbSrcNo = *itr;
        (*fLogFile) << "      "
                    << fLogTableName << " "
                    << fLogNumSeqNo[dbSrcNo] << " recs: "
                    << fLogSeqNoMin[dbSrcNo];
        if ( fLogSeqNoMin[dbSrcNo] != fLogSeqNoMax[dbSrcNo]
           ) (*fLogFile) << ".." << fLogSeqNoMax[dbSrcNo];
        (*fLogFile) << endl;
        ++itr;
      }
    }
    if ( tableName == "DBILOGENTRY" 
         ) (*fLogFile) << "Start of update log entries..." << endl;
    else if ( fLogTableName == "DBILOGENTRY" 
         ) (*fLogFile) << "End of update log entries..." << endl;

    fLogTableName =  tableName;
    fLogDBSrcNos.clear();
    fLogNumSeqNo.clear();
    fLogSeqNoMin.clear();
    fLogSeqNoMax.clear();

  }
    
// Buffer info for next summary.
  if ( tableName != "" ) {
    UInt_t dbSrcNo = seqNo/(Dbi::kMAXLOCALSEQNO+1);
    if (     find(fLogDBSrcNos.begin(), fLogDBSrcNos.end(), dbSrcNo)
          == fLogDBSrcNos.end() ) {
      fLogDBSrcNos.push_back(dbSrcNo);
      fLogSeqNoMin[dbSrcNo] = seqNo;
      fLogSeqNoMax[dbSrcNo] = seqNo;
      fLogNumSeqNo[dbSrcNo] = 1;
    }
    else {
      if ( fLogSeqNoMin[dbSrcNo] > seqNo ) fLogSeqNoMin[dbSrcNo] = seqNo;
      if ( fLogSeqNoMax[dbSrcNo] < seqNo ) fLogSeqNoMax[dbSrcNo] = seqNo;
      ++fLogNumSeqNo[dbSrcNo];
    }
  }

// Record DbiLogEntrys directly into the file.

  if ( tableName == "DBILOGENTRY" ) {
    DbiResultPtr<DbiLogEntry> rp("DBILOGENTRY",seqNo,fDbNo);
    const DbiLogEntry* le = rp.GetRow(0);
    if ( le ) (*fLogFile) << *le << endl;
  }

}

/*    Template for New Member Function

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

DbmLogFile:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Cotact:   N. West
//
//  Specification:-
//  =============
//
//  o 

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

//  None.


}

*/

---