sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Source file for the client api
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file Client.cpp
sl@0: */
sl@0: #include <test/rfilelogger.h>
sl@0: 
sl@0: 
sl@0: //_LIT8(KxmlHeader,"<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\r\n");
sl@0: 
sl@0: 
sl@0: // EKA1 requires DLL entry point
sl@0: //
sl@0: // RFileLogger class definition
sl@0: //
sl@0: 
sl@0: EXPORT_C RFileFlogger::RFileFlogger() : ilogbody(NULL)
sl@0: /**
sl@0:  * Create a new flogger client interface object with an empty body.
sl@0:  * @internalTechnology 
sl@0:  */
sl@0: 	{
sl@0: 	iLogfileTag=FALSE;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RFileFlogger::~RFileFlogger()
sl@0: /**
sl@0:  * Destructor
sl@0:  * @internalTechnology 
sl@0:  */
sl@0: 	{}
sl@0: 
sl@0: 
sl@0: 
sl@0: EXPORT_C TInt RFileFlogger::Connect()
sl@0: /**
sl@0:  * @return int - Standard error codes
sl@0:  * EKA2 all variants and EKA1 target.
sl@0:  * Server is an exe
sl@0:  */
sl@0: 	{
sl@0: 	// Sanity check to make sure it's not been called multiple times
sl@0: 	if (ilogbody)
sl@0: 		{
sl@0: 		return KErrAlreadyExists;
sl@0: 		}
sl@0: 	ilogbody = new RFileLoggerBody;
sl@0: 	if(!ilogbody)
sl@0: 		return KErrNoMemory;
sl@0: 
sl@0: 	TVersion version(KRFileLoggerMajorVersion,KRFileLoggerMinorVersion,KRFileLoggerBuildVersion);
sl@0: 	// Assume the server is already running and attempt to create a session
sl@0: 	
sl@0: 	TInt err = ilogbody->DoCreateSession(KFileLogrerServerName,version,8);
sl@0: 	if(err== KErrServerTerminated)
sl@0: 	{
sl@0: 		User::After(1000000); // OS need time to close previous server properly
sl@0: 		err = ilogbody->DoCreateSession(KFileLogrerServerName,version,8);
sl@0: 	}
sl@0: 
sl@0: 	if(err == KErrNotFound)
sl@0: 		{
sl@0: 		// Server not running
sl@0: 		// Construct the server binary name
sl@0: 		_LIT(KEmpty,"");
sl@0: 		// EKA2 is simple
sl@0: 		// No path required
sl@0: 		TBuf<32> serverFile;
sl@0: 		serverFile.Copy(KFileLogrerServerName);
sl@0: 		_LIT(KExe,".exe");
sl@0: 		serverFile.Append(KExe);
sl@0: 		RProcess server;
sl@0: 		err = server.Create(serverFile,KEmpty);
sl@0: 		if(err != KErrNone)
sl@0: 			return err;
sl@0: 		// Synchronise with the server
sl@0: 		TRequestStatus reqStatus;
sl@0: 		server.Rendezvous(reqStatus);
sl@0: 		server.Resume();
sl@0: 		// Server will call the reciprocal static synchronise call
sl@0: 		User::WaitForRequest(reqStatus);
sl@0: 		server.Close();
sl@0: 		if(reqStatus.Int() != KErrNone)
sl@0: 			return reqStatus.Int();
sl@0: 		// Create the root server session
sl@0: 		err = ilogbody->DoCreateSession(KFileLogrerServerName,version,8);
sl@0: 		}
sl@0: 		if (err != KErrNone)
sl@0: 		{  // some other problem, kill the logbody and clean the mamory
sl@0: 			delete ilogbody;
sl@0: 			ilogbody=NULL;
sl@0: 		}
sl@0: 		else
sl@0: 		{   // Makes the session shared among all threads in the process
sl@0: 			err = ilogbody->ShareAuto();
sl@0: 		}
sl@0: 
sl@0: 
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: ///////
sl@0: EXPORT_C TInt RFileFlogger::CreateLog(const TDesC& aLogFilePath, TLogMode aMode)
sl@0: /**
sl@0:  * @param aLogFilePath - Full path and filename of the log file
sl@0:  * @param aMode - Overwrite or Append
sl@0:  * Makes synchronous call to the log server to create a log session
sl@0:  */
sl@0: 	{
sl@0: 	iloglevel = ESevrAll; //ELogNone;
sl@0: 
sl@0: 	if(aLogFilePath.Length() > KMaxLoggerFilePath)
sl@0: 		return KErrTooBig;
sl@0: 
sl@0: 	TIpcArgs args;
sl@0: 	args.Set(0,&aLogFilePath);
sl@0: 	args.Set(1,aMode);
sl@0:     TInt err = ilogbody->DoSendReceive(ECreateLog,args);
sl@0:     return err; 
sl@0: 
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileFlogger::Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TRefByValue<const TDesC> aFmt,...)
sl@0: /**
sl@0:  * @param aFile - Source file name
sl@0:  * @param aLine - Source file line number
sl@0:  * @param aSeverity - ERR, WARN, INFO
sl@0:  * @param aFmt - UNICODE format string
sl@0:  */
sl@0: 	{
sl@0: 	// Set up a Variable argument list and call private method
sl@0: 	if (aSeverity>iloglevel && aSeverity != ESevrTEFUnit) 
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 	Log(aFile, aLine, aSeverity, aFmt, aList);
sl@0: 	VA_END(aList); 
sl@0: 
sl@0: 	}
sl@0: EXPORT_C void RFileFlogger::Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity,TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt,...)
sl@0: /**
sl@0:  * @param aFile - Source file name
sl@0:  * @param aLine - Source file line number
sl@0:  * @param aSeverity - ERR, WARN, INFO
sl@0:  * @param aFmt - UNICODE format string
sl@0:  */
sl@0: 	{
sl@0: 	// Set up a Variable argument list and call private method
sl@0: 	if (aSeverity>iloglevel && aSeverity != ESevrTEFUnit) 
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 	Log(aFile, aLine, aSeverity, arraylength, aLogFields, aFmt, aList);
sl@0: 	VA_END(aList); 
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void RFileFlogger::AddTime(TDes8& aLogBuffer)
sl@0: 	{
sl@0: 	TTime now;
sl@0: 	now.UniversalTime();
sl@0: 	TDateTime dateTime = now.DateTime();
sl@0: 	_LIT8(KFormat,"%02d:%02d:%02d:%03d");
sl@0: 	// add the current time. 
sl@0: /*--------- Maintaince Warning for aLogBuffer -----------------------------------
sl@0: ******* the fomat of below string is sensible to server.  
sl@0: ******* Adding any string to the aLogBuffer has to be checked 
sl@0: ******* in code on server side 
sl@0: --------------------------------------------------------------------------------*/
sl@0: 	aLogBuffer.AppendFormat(KFormat,dateTime.Hour(),dateTime.Minute(),dateTime.Second(),(dateTime.MicroSecond()/1000)); 
sl@0: /*--------------- End of Maintaince Warning  ----------------*/
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileFlogger::Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TRefByValue<const TDesC> aFmt, VA_LIST aList)
sl@0: 	{
sl@0: 	if (aSeverity>iloglevel && aSeverity != ESevrTEFUnit) 
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	TInt arraylength = 0;
sl@0: 	TExtraLogField* aLogFields =NULL;	
sl@0: 	Log(aFile, aLine, aSeverity, arraylength, aLogFields, aFmt, aList);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileFlogger::Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity,TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt, VA_LIST aList)
sl@0: /**
sl@0:  * @param aFile - Source file name
sl@0:  * @param aLine - Source file line number
sl@0:  * @param aSeverity - ERR, WARN, INFO
sl@0:  * @param arraylength
sl@0:  * @param aLogFields
sl@0:  * @param aFmt - UNICODE format string
sl@0:  * @param aList - Variable argument list
sl@0:  *
sl@0:  * Format a log output line
sl@0:  */
sl@0:  	{
sl@0: 	if (aSeverity>iloglevel && aSeverity != ESevrTEFUnit) 
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	if (aSeverity == ESevrTEFUnit)
sl@0: 		{
sl@0: 		aSeverity = ESevrInfo;
sl@0: 		}
sl@0: /*----- Maintaince Warning for this section: -----------------------------------
sl@0: ******* the fomat of below string is very sensible to server Server 
sl@0: ******* defomating these string with the understanding of this 
sl@0: ******* perticular format. Any change made here should be checked 
sl@0: ******* in code on server side 
sl@0: --------------------------------------------------------------------------------*/
sl@0: 	// Create a filename string
sl@0: 	TBuf16<KMaxFilename> fileName;
sl@0: 	GetCPPModuleName(fileName, aFile);  
sl@0: 	// Create a buffer for formatting
sl@0: 	HBufC* buffer = HBufC::New(KMaxLoggerLineLength*2);
sl@0: 	if(!buffer)
sl@0: 		return;  // no memory
sl@0: 	TPtr ptr(buffer->Des());
sl@0: 	_LIT(KEnd,"\r\n");
sl@0: 	_LIT(KErr,"ERROR");
sl@0: 	_LIT(KHigh,"HIGH");
sl@0: 	_LIT(KWarn,"WARN");
sl@0: 	_LIT(KMedium,"MEDIUM");
sl@0: 	_LIT(KInfo,"INFO");
sl@0: 	_LIT(KLow,"LOW");
sl@0: //	ptr.Append(KTypeTagBeging);
sl@0: 	ptr.Append(KSeperation);
sl@0: 	if(aSeverity == ESevrErr)
sl@0: 		ptr.Append(KErr);
sl@0: 	else if(aSeverity == ESevrHigh)
sl@0: 		ptr.Append(KHigh);
sl@0: 	else if(aSeverity == ESevrWarn)
sl@0: 		ptr.Append(KWarn);
sl@0: 	else if(aSeverity == ESevrMedium)
sl@0: 		ptr.Append(KMedium);
sl@0: 	else if (aSeverity == ESevrInfo)
sl@0: 		ptr.Append(KInfo);
sl@0: 	else if(aSeverity == ESevrLow)
sl@0: 		ptr.Append(KLow);
sl@0: 	else //if(aSeverity == ESevrAll)
sl@0: 		ptr.Append(KInfo);
sl@0: 	// Add the thread id -------- read CIniData to decide the level of details
sl@0: 	ptr.AppendFormat(KMessageFormat,(TInt)(RThread().Id()),&fileName, aLine);
sl@0: 	ptr.AppendFormatList(aFmt, aList);
sl@0: 	if(arraylength>0)  // trust user providing correct number with actual arrary length
sl@0: 	{
sl@0: 		_LIT(KTab,"\t");
sl@0: 		// presuming the following string is hardly being apart of log message from users
sl@0: 		// and no carrige return and line feed in their log field name and field value
sl@0: 		ptr.Append(KEnd);
sl@0: 		ptr.Append(KTagSeperation);
sl@0: 		ptr.Append(KTab);
sl@0: 		ptr.AppendNum(TInt64(arraylength));
sl@0: 		TInt loopValue(arraylength);
sl@0: 		while(loopValue)
sl@0: 		{
sl@0: 			ptr.Append(KEnd);
sl@0: 			ptr.Append(aLogFields->iLogFieldName);
sl@0: 			ptr.Append(KTab);
sl@0: 			ptr.Append(aLogFields->iLogFieldValue);
sl@0: 			loopValue--; // Decrement the looping until all fields are exhausted
sl@0: 			aLogFields++; // Increment the pointer address to access sucessive array index values			
sl@0: 		}
sl@0: 		ptr.Append(KEnd);
sl@0: 		ptr.Append(KTagSeperationEnd);
sl@0: 
sl@0: 	}
sl@0: /*----------------- End of Maintaince warning section --------------------------*/
sl@0: 	TRAP_IGNORE(WriteL(ptr));
sl@0: 
sl@0: 	delete buffer;
sl@0: 
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void RFileFlogger::WriteL(const TDesC& aLogBuffer)
sl@0: /**
sl@0:  * @param aLogBuffer - UNICODE buffer
sl@0:  */
sl@0: 	{
sl@0: 	HBufC8* buffer = HBufC8::NewLC(aLogBuffer.Length()+100);
sl@0: 	if(!buffer)
sl@0: 		return;  // no memory
sl@0: 	TPtr8 ptr(buffer->Des());
sl@0: 	AddTime(ptr);
sl@0: 	ptr.Append(aLogBuffer);
sl@0: 	TRAP_IGNORE(WriteL(ptr));
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(buffer);
sl@0: 	}
sl@0: 
sl@0: void RFileFlogger::WriteL(TDes8& aLogBuffer)
sl@0: /**
sl@0:  * @param aLogBuffer - pre-formatted narrow buffer
sl@0:  * 
sl@0:  * Synchronous write to the server
sl@0:  */
sl@0: 	{
sl@0: 	_LIT8(KEnd,"\r\n");
sl@0: 	// Check to see if there's room to add CRLF
sl@0: 	if(aLogBuffer.Length()+2 > aLogBuffer.MaxLength())
sl@0: 		{
sl@0: 		HBufC8* buffer = HBufC8::NewLC(aLogBuffer.Length()+2);
sl@0: 		if(!buffer)
sl@0: 			return;  // no memory
sl@0: 		TPtr8 ptr(buffer->Des());
sl@0: 		ptr.Copy(aLogBuffer);
sl@0: 		TBuf8<4> tempBuf(_L8("\r\n"));
sl@0: 		if (aLogBuffer.Mid(aLogBuffer.Length()-2,2).CompareF(tempBuf) != 0)
sl@0: 			ptr.Append(KEnd);
sl@0: 		TIpcArgs args;
sl@0: 		args.Set(0,&ptr);
sl@0: 		args.Set(1,ptr.Length());
sl@0: 		User::LeaveIfError(ilogbody->DoSendReceive(EWriteLog,args));
sl@0: 		CleanupStack::PopAndDestroy(buffer);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		TBuf8<4> tempBuf(_L8("\r\n"));
sl@0: 		if (aLogBuffer.Mid(aLogBuffer.Length()-2,2).CompareF(tempBuf) != 0)
sl@0: 			aLogBuffer.Append(KEnd);
sl@0: 		TIpcArgs args;
sl@0: 		args.Set(0,&aLogBuffer);
sl@0: 		args.Set(1,aLogBuffer.Length());
sl@0: 		User::LeaveIfError(ilogbody->DoSendReceive(EWriteLog,args));
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void RFileFlogger::GetCPPModuleName(TDes& aModuleName, const TText8* aCPPFileName)
sl@0: /**
sl@0:  * @return aModuleName - Filename in descriptor
sl@0:  * @param aCppFileName - Filename
sl@0:  * Borrowed from scheduletest
sl@0:  */
sl@0: 	{
sl@0: 	TPtrC8 fileNamePtrC8(aCPPFileName);
sl@0: 	// We do our own filename munging here; TParse can't help us since that's
sl@0: 	// expressly for EPOC filepaths and here we've got whatever the build system is
sl@0: 	// At present Win32 and Unix directory delimiters are supported
sl@0: 	TInt lastDelimiter = Max(fileNamePtrC8.LocateReverse('\\'), fileNamePtrC8.LocateReverse('/'));
sl@0: 	if(lastDelimiter >= 0 && lastDelimiter < fileNamePtrC8.Length() - 1)
sl@0: 		{
sl@0: 		// Found a delimiter which isn't trailing; update the ptr to start at the next char
sl@0: 		TInt fileNameLen = Min(KMaxFilename, fileNamePtrC8.Length() - (lastDelimiter + 1));
sl@0: 		fileNamePtrC8.Set(aCPPFileName + lastDelimiter + 1, fileNameLen);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// Didn't find a delimiter; take as much of the right-end of the name as fits
sl@0: 		fileNamePtrC8.Set(aCPPFileName + Max(0, fileNamePtrC8.Length() - KMaxFilename), Min(fileNamePtrC8.Length(), KMaxFilename));
sl@0: 		}
sl@0: 	aModuleName.Copy(fileNamePtrC8);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: EXPORT_C void RFileFlogger::SetLogLevel(TLogSeverity aloglevel)
sl@0: 	{
sl@0: 	iloglevel=aloglevel;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void RFileFlogger::Close()
sl@0: 	{
sl@0:   	if(ilogbody)
sl@0:   		{
sl@0: 		ilogbody->Close();
sl@0: 		delete ilogbody;
sl@0: 		ilogbody = NULL;
sl@0:   		}
sl@0: 	}
sl@0: 
sl@0: