muo_logging.cc

Go to the documentation of this file.

/*
 * Copyright (C) 2001 Karsten Reincke <reincke@gnukose.org>
 *  
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *  
 * file <muo_logging.cc> version <#1.3.1#> of project <MrProjext>
 */   

#include <iostream.h>
#include <time.h>
#include "muo_logging.h"
using namespace krmuo;
/* &&& (1) local preprocessor-defines &&&&&&&&&&&&&&&&&&&&&&& */

/* &&& (2) definitions of static global variables &&&&&&&&&&& */
          // note: they mustn´t again be declared as static
 
/* &&& (3) &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
/* &&&     methods for class LoggingSuitcase &&& */

/* --- (3.A) public ------------------------------------------ */

/* :-: (3.A.1) public constructors, inits & operators -:-:-:-: */

LoggingUnit::LoggingUnit
( const unsigned int pMaxVisibleMessageLevel,
  FILE *pScreen)
: mMaxVisibleMessageLevel(pMaxVisibleMessageLevel),
  mScreen(pScreen),
  mLogFileName(""),
  mFile(NULL),
  mUsesSharedLoggingFile(false)
{
}

LoggingUnit::LoggingUnit
( const unsigned int pMaxVisibleMessageLevel,
  const string& pLogFileName,
  bool pUsesSharedLoggingFile)
: mMaxVisibleMessageLevel(pMaxVisibleMessageLevel),
  mScreen(NULL),
  mLogFileName(pLogFileName),
  mFile(NULL),
  mUsesSharedLoggingFile(pUsesSharedLoggingFile)
{
  if (!(mUsesSharedLoggingFile))
  {
    mFile=fopen(mLogFileName.c_str(),"a");
    if (!(mFile))
    {
      mScreen=stderr;
      cerr << "Can't open logfile <" << pLogFileName<<">\n";
    }
  }
}

LoggingUnit::LoggingUnit
( const unsigned int pMaxVisibleMessageLevel,
  FILE *pScreen,
  const string& pLogFileName,
  bool pUsesSharedLoggingFile)
: mMaxVisibleMessageLevel(pMaxVisibleMessageLevel),
  mScreen(pScreen),
  mLogFileName(pLogFileName),
  mFile(NULL),
  mUsesSharedLoggingFile(pUsesSharedLoggingFile)
{
  if (!(mUsesSharedLoggingFile))
  {
    mFile=fopen(mLogFileName.c_str(),"a");
    if (!(mFile))
    {
      mScreen=stderr;
      cerr << "Can't open logfile <" << pLogFileName<<">\n";
    }
  }
}

LoggingUnit::~LoggingUnit()
{
  if (mFile)
    fclose(mFile);
}

/* :-: (3.A.2) public getter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (3.A.3) public setter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (3.A.4) public others -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
void LoggingUnit::makeEntry
( const string& pLogString,
  const unsigned int pLogEntryLevel
) const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      fprintf(mScreen,"%s (LL%d): %s\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str());
    }
    FILE *lFile;
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      fprintf(lFile,"%s (LL%d): %s\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str());
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }    
  }
}
void LoggingUnit::makeEntry
( const string& pLogString1,
  const string& pLogString2, 
  const unsigned int pLogEntryLevel
) const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {    
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      fprintf(mScreen,"%s (LL%d): %s: <%s>\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
    }
    FILE *lFile;  
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      fprintf(lFile,"%s (LL%d): %s: <%s>\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }    
  }  
}

void LoggingUnit::makeEntry
( const string& pLogString1,
  const string& pLogString2, 
  const string& pLogString3,  
  const unsigned int pLogEntryLevel
)const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {    
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      fprintf(mScreen,"%s (LL%d): %s: <%s [%s]>\n",
        timeLabel.c_str(),pLogEntryLevel,
          pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
    }
    FILE *lFile;  
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      fprintf(lFile,"%s (LL%d): %s: <%s [%s]>\n",
        timeLabel.c_str(),pLogEntryLevel,
          pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }    
  }  
}

void LoggingUnit::makeEntry
( const string& pLogString1,
  const string& pLogString2, 
  const unsigned int pLogEntryLevel,
  bool pTwoLine
) const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {    
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      if (pTwoLine)
        fprintf(mScreen,"%s (LL%d): %s:\n%s\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
      else
        fprintf(mScreen,"%s (LL%d): %s: <%s>\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
    }
    FILE *lFile;  
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      if (pTwoLine)
        fprintf(lFile,"%s (LL%d): %s:\n%s\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
      else
        fprintf(lFile,"%s (LL%d): %s: <%s>\n",timeLabel.c_str(),pLogEntryLevel,pLogString1.c_str(),pLogString2.c_str());
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }       
  }
}

void LoggingUnit::makeEntry
( const string& pLogString1,
  const string& pLogString2, 
  const string& pLogString3, 
  const unsigned int pLogEntryLevel,
  bool pTwoLine
) const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {    
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      if (pTwoLine)
        fprintf(mScreen,"%s (LL%d): %s:\n%s [%s]\n",
          timeLabel.c_str(),pLogEntryLevel,
            pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
      else
        fprintf(mScreen,"%s (LL%d): %s: <%s [%s]>\n",
          timeLabel.c_str(),pLogEntryLevel,
            pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
    }
    FILE* lFile;
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      if (pTwoLine)
        fprintf(lFile,"%s (LL%d): %s:\n%s [%s]\n",
          timeLabel.c_str(),pLogEntryLevel,
            pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
      else
        fprintf(lFile,"%s (LL%d): %s: <%s [%s]>\n",
          timeLabel.c_str(),pLogEntryLevel,
            pLogString1.c_str(),pLogString2.c_str(),pLogString3.c_str());
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }       
  }
}

void LoggingUnit::makeEntry
( const string& pLogString,
  const unsigned int pLogUint, 
  const unsigned int pLogEntryLevel
)const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {    
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      fprintf(mScreen,"%s (LL%d): %s <%d>\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str(),pLogUint);
    }
    FILE* lFile;
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      fprintf(lFile,"%s (LL%d): %s <%d>\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str(),pLogUint);
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }    
  }  
}

void LoggingUnit::makeEntry
( const string& pLogString,
  const int pLogInt, 
  const unsigned int pLogEntryLevel
)const
{
  if (pLogEntryLevel<=mMaxVisibleMessageLevel)
  {
    string timeLabel="";
    fillTimeLabel(timeLabel);  
    if (mScreen)
    {
      fprintf(mScreen,"%s (LL%d): %s <%d>\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str(),pLogInt);
    }
    FILE* lFile;    
    if (mUsesSharedLoggingFile)
      lFile=fopen(mLogFileName.c_str(),"a");
    else
      lFile=mFile;
    if (lFile)
    {
      fprintf(lFile,"%s (LL%d): %s <%d>\n",timeLabel.c_str(),pLogEntryLevel,pLogString.c_str(),pLogInt);
      fflush(lFile);
      if (mUsesSharedLoggingFile)
      {
        fclose(lFile);
      }
    }    
  }  
}

/* --- (3.B) - private ---------------------------------------- */
/* :-: (3.B.1) private constructors, inits & operators -:-:-:-: */

/* :-: (3.B.2) private getter -:-:-:-:-:-:-:-:-:-::-:-:-:-:-:-: */
/* :-: (3.B.3) private setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (3.B.4) private others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
void LoggingUnit::fillTimeLabel(string& pTimeLabel)const
{
  char lBuffer[100];
  time_t now=time(NULL);
  tm *np=localtime(&now);
  sprintf
  ( lBuffer,"%04d%02d%02dT%02d%02d%02d",
            (np->tm_year+1900),(np->tm_mon+1),np->tm_mday,
            np->tm_hour,np->tm_min,np->tm_sec);
  pTimeLabel=lBuffer;
}  

/* --- (3.C) - protected -------------------------------------- */
/* :-: (3.C.1) protected getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (3.C.2) protected setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (3.C.3) protected others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* &&& (4) &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
/* &&&     methods for class LoggingSuitcase &&& */

/* --- (4.A) public ------------------------------------------ */

/* :-: (4.A.1) public constructors, inits & operators -:-:-:-: */

LoggingSuitcase::LoggingSuitcase
( const unsigned int pShowActionMessages,
  const unsigned int pShowErrorMessages
)
: mActionLoggingUnit(pShowActionMessages,stdout),
  mWarnLoggingUnit(pShowErrorMessages,stderr),
  mErrorLoggingUnit(pShowErrorMessages,stderr)
{
}

LoggingSuitcase::LoggingSuitcase
( const unsigned int pShowActionMessages,
  const unsigned int pShowErrorMessages,
  const string& pLogDirPath,
  const string& pLogFileNameKernel,
  bool pUsesSharedLoggingFile
)
: mActionLoggingUnit
  ( pShowActionMessages, 
    (pLogDirPath + "/" + pLogFileNameKernel + "_action.log"),
    pUsesSharedLoggingFile
  ),
  mWarnLoggingUnit
  ( pShowErrorMessages, 
    (pLogDirPath + "/" + pLogFileNameKernel + "_warn.log"),
    pUsesSharedLoggingFile
  ),
  mErrorLoggingUnit
  ( pShowErrorMessages, 
    (pLogDirPath + "/" + pLogFileNameKernel + "_error.log"),
    pUsesSharedLoggingFile
  )
{
}

LoggingSuitcase::LoggingSuitcase
( const unsigned int pShowActionMessages,
  const unsigned int pShowErrorMessages,
  bool pWithScreenMessages,
  const string& pLogDirPath,
  const string& pLogFileNameKernel,
  bool pUsesSharedLoggingFile
)
: mActionLoggingUnit
  ( pShowActionMessages, 
    stdout,
    (pLogDirPath + "/" + pLogFileNameKernel + "_action.log"),
    pUsesSharedLoggingFile
  ),
  mWarnLoggingUnit
  ( pShowErrorMessages, 
    stderr,
    (pLogDirPath + "/" + pLogFileNameKernel + "_warn.log"),
    pUsesSharedLoggingFile
  ),
  mErrorLoggingUnit
  ( pShowErrorMessages, 
    stderr,
    (pLogDirPath + "/" + pLogFileNameKernel + "_error.log"),
    pUsesSharedLoggingFile
  )
{
  if (!(pWithScreenMessages))
  {
    turnOffScreenWriting();
  }   
}
LoggingSuitcase::~LoggingSuitcase()
{

}
/* :-: (4.A.2) public getter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (4.A.3) public setter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (4.A.4) public others -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* --- (4.B) - private ---------------------------------------- */
/* :-: (4.B.1) private constructors, inits & operators -:-:-:-: */

/* :-: (4.B.2) private getter -:-:-:-:-:-:-:-:-:-::-:-:-:-:-:-: */
/* :-: (4.B.3) private setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (4.B.4) private others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* --- (4.C) - protected -------------------------------------- */
/* :-: (4.C.1) protected getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (4.C.2) protected setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (4.C.3) protected others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* &&& (X) &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
/* &&&     methods for class &&& */

/* --- (X.A) - public ----------------------------------------- */
/* :-: (X.A.1) public constructors, inits & operators :-:-:-:-: */
/* :-: (X.A.2) public getter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (X.A.3) public setter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (X.A.4) public others -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* --- (X.B) - private ---------------------------------------- */
/* :-: (X.B.1) private constructors, inits & operators -:-:-:-: */
/* :-: (X.B.2) private getter -:-:-:-:-:-:-:-:-:-::-:-:-:-:-:-: */
/* :-: (X.B.3) private setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (X.B.4) private others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

/* --- (X.C) - protected -------------------------------------- */
/* :-: (X.C.1) protected getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (X.C.2) protected setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
/* :-: (X.C.3) protected others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */

---