realtimenetprots/sipfw/SIP/Logging/src/TSIPMessageLogger.cpp
changeset 0 307788aac0a8
child 55 36ea1f90a3d8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Name          : TSIPMessageLogger.cpp
       
    15 // Part of       : Logging
       
    16 // Version       : SIP/4.0 
       
    17 //
       
    18 
       
    19 
       
    20 
       
    21 #include "SipLogs.h"
       
    22 
       
    23 #ifdef USE_SIP_MESSAGE_LOG
       
    24 
       
    25 #include <flogger.h>
       
    26 #include "TSIPMessageLogger.h"
       
    27 #include "TSIPLogLineParser.h"
       
    28 #include "sipmessage.h"
       
    29 
       
    30 _LIT(KSIPMessageLogFileDir, "Sip");
       
    31 _LIT(KSIPMessageLogFileName, "SipLog.txt");
       
    32 //_LIT(KSipLogPath, "C:\\logs\\sip\\");
       
    33 
       
    34 _LIT8(KFormatParseError, "    SIP Codec parse error: %d!");
       
    35 _LIT8(KFooter, "-----");
       
    36 
       
    37 // Leave some space for date and time:
       
    38 const TInt KMaxLineLength = KLogBufferSize-50;
       
    39 
       
    40 #ifdef WRITE_EXTRA_LOGS
       
    41 const TInt KSensibleLineLength = 60;
       
    42 _LIT8(KShortFooter, "---");
       
    43 #endif
       
    44 
       
    45 // -----------------------------------------------------------------------------
       
    46 // TSIPMessageLogger::Write
       
    47 // -----------------------------------------------------------------------------
       
    48 //
       
    49 void TSIPMessageLogger::Write(
       
    50     const TDesC8& aSubsystemName,
       
    51     CSIPMessage& aSIPMessage )
       
    52     {
       
    53     CBufBase* sipMessageAsText = 0;
       
    54     TRAPD( err, sipMessageAsText = aSIPMessage.ToTextHeaderPartL() );
       
    55     if (err != KErrNone)
       
    56         {
       
    57         WriteParseError( aSubsystemName, err );
       
    58         }
       
    59     else
       
    60         {
       
    61         Write( aSubsystemName, sipMessageAsText->Ptr( 0 ) );
       
    62         delete sipMessageAsText;
       
    63         }
       
    64     }
       
    65 
       
    66 // -----------------------------------------------------------------------------
       
    67 // TSIPMessageLogger::Write
       
    68 // -----------------------------------------------------------------------------
       
    69 //
       
    70 void TSIPMessageLogger::Write(
       
    71     const TDesC8& aSubsystemName,
       
    72     const TDesC8& aSIPMessage)
       
    73     {
       
    74     TBool exists = LogDirExists( KSipLogPath );
       
    75     
       
    76     if ( exists )
       
    77         {
       
    78         RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
    79                             EFileLoggingModeAppend, aSubsystemName);
       
    80         }
       
    81     else
       
    82         {
       
    83         RDebug::RawPrint( aSubsystemName );
       
    84         }
       
    85   
       
    86     WriteSipMessage (aSIPMessage);
       
    87     
       
    88 #ifdef WRITE_EXTRA_LOGS
       
    89     if ( exists )
       
    90         {
       
    91         RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
    92                             EFileLoggingModeAppend,KShortFooter);
       
    93       }
       
    94     else
       
    95         {
       
    96         RDebug::RawPrint( KShortFooter );
       
    97         }
       
    98     WriteExtraLogs(aSIPMessage);
       
    99 #endif
       
   100 
       
   101     if ( exists )
       
   102         {
       
   103         RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
   104                             EFileLoggingModeAppend,KFooter);
       
   105         }
       
   106     else
       
   107         {
       
   108         RDebug::RawPrint( KFooter );
       
   109         }
       
   110     }
       
   111 
       
   112 // -----------------------------------------------------------------------------
       
   113 // TSIPMessageLogger::WriteParseError
       
   114 // -----------------------------------------------------------------------------
       
   115 //
       
   116 void TSIPMessageLogger::WriteParseError(
       
   117     const TDesC8& aSubsystemName,
       
   118     TInt aError)
       
   119     {
       
   120     if ( LogDirExists( KSipLogPath ) )
       
   121         {
       
   122         RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
   123                             EFileLoggingModeAppend,
       
   124                             aSubsystemName);
       
   125 
       
   126         RFileLogger::WriteFormat( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
   127                                   EFileLoggingModeAppend,
       
   128                                   KFormatParseError, aError);
       
   129 
       
   130         RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
   131                             EFileLoggingModeAppend,KFooter);
       
   132         }
       
   133     else
       
   134         {
       
   135         _LIT8( KFmt, "%d" );
       
   136         TBuf8<32> buf;
       
   137         buf.Format( KFmt, aError );
       
   138         RDebug::RawPrint( aSubsystemName );
       
   139         RDebug::RawPrint( buf );
       
   140         RDebug::RawPrint( KFooter );
       
   141         }
       
   142     }
       
   143 
       
   144 // -----------------------------------------------------------------------------
       
   145 // TSIPMessageLogger::WriteSipMessage
       
   146 // -----------------------------------------------------------------------------
       
   147 //
       
   148 void TSIPMessageLogger::WriteSipMessage (const TDesC8& aSIPMessage)
       
   149     {
       
   150     TSIPLogLineParser lineParser( aSIPMessage, KMaxLineLength );
       
   151     
       
   152     if ( LogDirExists( KSipLogPath ) )
       
   153         { 
       
   154         while ( !lineParser.End())
       
   155             {
       
   156             RFileLogger::Write( KSIPMessageLogFileDir,KSIPMessageLogFileName, 
       
   157                                 EFileLoggingModeAppend,
       
   158                                 lineParser.GetLine());
       
   159             }
       
   160         }
       
   161     else
       
   162         {
       
   163         while ( !lineParser.End() )
       
   164             {
       
   165             RDebug::RawPrint( lineParser.GetLine() );
       
   166             }
       
   167         }
       
   168     }
       
   169 
       
   170 // -----------------------------------------------------------------------------
       
   171 // TSIPMessageLogger::LogDirExists
       
   172 // -----------------------------------------------------------------------------
       
   173 //
       
   174 TBool TSIPMessageLogger::LogDirExists( const TDesC& aFolderName )
       
   175     {
       
   176     TBool exists( EFalse );
       
   177     RFs fs;
       
   178     if ( KErrNone == fs.Connect() )
       
   179         {
       
   180         TEntry entry;
       
   181         exists = ( fs.Entry( aFolderName, entry ) == KErrNone );
       
   182         fs.Close();        
       
   183         }
       
   184     return exists;
       
   185     }
       
   186     
       
   187 // -----------------------------------------------------------------------------
       
   188 // TSIPMessageLogger::WriteExtraLogs
       
   189 // -----------------------------------------------------------------------------
       
   190 //
       
   191 #ifdef WRITE_EXTRA_LOGS
       
   192 void TSIPMessageLogger::WriteExtraLogs(const TDesC8& aSIPMessage)
       
   193     {
       
   194     TBuf8<KMaxLineLength> buf;
       
   195     for (TInt i = 0; i < aSIPMessage.Length(); i++)
       
   196         {
       
   197         if (aSIPMessage[i] > 0x20 && aSIPMessage[i] < 0x7f)
       
   198             {
       
   199             buf.Append(aSIPMessage[i]);
       
   200             }
       
   201         else
       
   202             {
       
   203             //Print few of the most common invisible characters with abbreviations
       
   204             switch(aSIPMessage[i])
       
   205                 {
       
   206                 case 0x0:
       
   207                     buf.Append(_L8("<nul>")); break;
       
   208                 case 0x9:
       
   209                     buf.Append(_L8("<tab>")); break;
       
   210                 case 0xa:
       
   211                     buf.Append(_L8("<lf>")); break;
       
   212                 case 0xd:
       
   213                     buf.Append(_L8("<cr>")); break;
       
   214                 case 0x1b:
       
   215                     buf.Append(_L8("<esc>")); break;
       
   216                 case 0x20:
       
   217                     buf.Append(_L8("<sp>")); break;
       
   218                 default:
       
   219                     buf.Append(_L8("#"));
       
   220                 }
       
   221 
       
   222             }
       
   223         
       
   224         if (buf.Length() >= KSensibleLineLength)
       
   225             {
       
   226             //Buffer full, write it to log file
       
   227             RFileLogger::Write (KSIPMessageLogFileDir,KSIPMessageLogFileName,
       
   228                                 EFileLoggingModeAppend, buf);
       
   229             buf.Zero();
       
   230             }
       
   231         }
       
   232 
       
   233     if (buf.Length() > 0)
       
   234         {
       
   235         if ( LogDirExists( KSipLogPath ) )
       
   236             {
       
   237             RFileLogger::Write (KSIPMessageLogFileDir,KSIPMessageLogFileName, 
       
   238                             EFileLoggingModeAppend, buf);
       
   239           }
       
   240         else
       
   241             {
       
   242             RDebug::RawPrint( buf );
       
   243             }
       
   244         }
       
   245     }
       
   246 #endif // WRITE_EXTRA_LOGS
       
   247 
       
   248 #endif // USE_SIP_MESSAGE_LOG