sl@0: // Copyright (c) 2002-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: // sl@0: sl@0: // EPOC includes sl@0: #include sl@0: sl@0: // Test system includes sl@0: #include "LogFile.h" sl@0: sl@0: sl@0: /* sl@0: * destructor for CFileLogger. sl@0: */ sl@0: CFileLogger::~CFileLogger() sl@0: { sl@0: // make sure session to file server is closed sl@0: Close(); sl@0: } sl@0: sl@0: sl@0: /** sl@0: * sl@0: * Static constructor for CFileLogger. sl@0: * sl@0: * @return "CFileLogger*" sl@0: * The constructed CFileLogger sl@0: * sl@0: * @xxxx sl@0: * sl@0: */ sl@0: CFileLogger* CFileLogger::NewL() sl@0: { sl@0: CFileLogger* s = new(ELeave) CFileLogger; sl@0: return s; sl@0: } sl@0: sl@0: /** sl@0: * sl@0: * Create and open a log file. The file is shareable, and a mutex sl@0: * and file seeks employed in case more than one session is using sl@0: * the file. sl@0: * sl@0: * @param "const TDesC& aDir" sl@0: * The file path of the logfile to be created. If the path sl@0: * does not exist, the logfile will not be created. sl@0: * sl@0: * @param "const TDesC& aName" sl@0: * The file name of same. sl@0: * sl@0: * @xxxx sl@0: * sl@0: */ sl@0: void CFileLogger::CreateLog(const TDesC& aDir, const TDesC& aName) sl@0: { sl@0: // if aDir or aName are empty, then panic sl@0: __ASSERT_ALWAYS(aDir.Ptr() != NULL, User::Panic(_L("CFileLogger"), 0)); sl@0: __ASSERT_ALWAYS(aName.Ptr() != NULL, User::Panic(_L("CFileLogger"), 1)); sl@0: sl@0: sl@0: // if aDir doesn't exist, create it anyway sl@0: TUint aAttValue; sl@0: if (iFs.Att(aDir, aAttValue) != KErrNone) sl@0: { sl@0: TInt returnCode = iFs.MkDirAll(aDir); sl@0: if (returnCode != KErrNone) sl@0: { sl@0: iEnabled = EFalse; sl@0: User::Panic(_L("CFileLogger"), 2); sl@0: } sl@0: } sl@0: sl@0: iEnabled = ETrue; sl@0: iLogName = aName; sl@0: sl@0: // create logfile mutex sl@0: RMutex logMutex; sl@0: logMutex.CreateGlobal(iLogName); sl@0: sl@0: // make the correct file name sl@0: TFileName logFile; sl@0: logFile.Format(_L("%S%S"), &aDir, &aName); // aDir will be \\-terminated sl@0: sl@0: // If the file does not exist, create it. If it does, truncate it sl@0: // Open it for sharing sl@0: TInt returnCode=iLogfile.Replace(iFs, logFile, EFileWrite | EFileStreamText | EFileShareAny); sl@0: sl@0: // check if open fails sl@0: if (returnCode==KErrNone) sl@0: { sl@0: //file has opened ok sl@0: //add the start to the HTML sl@0: iLogfile.Write(_L8("

\n"));
sl@0: 		TInt dummy;
sl@0: 		iLogfile.Seek(ESeekEnd, dummy);
sl@0: 		}
sl@0: 	else
sl@0: 		iEnabled = EFalse;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Close the logfile. The flag iEnabled will be clear if there
sl@0:  * is no logfile to close.
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CFileLogger::CloseLog()
sl@0: 	{
sl@0: 
sl@0: 	// this should be mutex-safe as each thread has its own handle to 
sl@0: 	// the log file
sl@0: 	// if logging enabled, flush buffers
sl@0: 	if (iEnabled)
sl@0: 		{
sl@0: 		iLogfile.Flush();
sl@0: 		iLogfile.Close();
sl@0: 		iEnabled = EFalse;
sl@0: 		}
sl@0: 
sl@0: 	// disconnect from the file server
sl@0: 	iFs.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Write output to the logfile.
sl@0:  *
sl@0:  * @param	"const TDesC& aMsg"
sl@0:  *          The message (string) to be written.
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CFileLogger::WriteLog(const TDesC& aMsg)
sl@0: 	{
sl@0: 
sl@0: 	if (!iEnabled) 
sl@0: 		return;
sl@0: 
sl@0: 	// convert from unicode to 8 bit
sl@0: 	TBuf8 lineBuf8;
sl@0: 	const TText* msgBuf = aMsg.Ptr();
sl@0: 	for (TInt i = 0; i < aMsg.Length() ;i++)
sl@0: 		lineBuf8.Append(STATIC_CAST(TText, msgBuf[i]));
sl@0: 
sl@0: 	// wait on mutex
sl@0: 	RMutex logMutex;
sl@0:    	logMutex.OpenGlobal(iLogName);
sl@0: 
sl@0: 	logMutex.Wait();
sl@0: 
sl@0: 	// write to log file
sl@0: 	TInt dummy=0;
sl@0: 	iLogfile.Seek(ESeekEnd, dummy);
sl@0: 	iLogfile.Write(lineBuf8);
sl@0: 	// seek to end after write - in case another process or thread is also using the file
sl@0: 	dummy=0; //dummy is updated after a seek to contain the new file position. With ESeekEnd
sl@0: 	         //it is used as an offest value to control the seek.
sl@0: 	iLogfile.Seek(ESeekEnd, dummy);
sl@0: 
sl@0: 	logMutex.Signal();
sl@0: 	logMutex.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Connect to the file server. Used as a helper function
sl@0:  * by classes owning a CFileLogger, to ensure that a
sl@0:  * file server session can be opened
sl@0:  *
sl@0:  * @return	"TInt"
sl@0:  *			standard EPOC error code
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: TInt CFileLogger::Connect()
sl@0: 	{
sl@0: 	TInt err = iFs.Connect();
sl@0: 	if (err == KErrNone)
sl@0: 		iFsOpen = ETrue;
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Close a file server session. Used as a helper function
sl@0:  * by classes owning a CFileLogger.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CFileLogger::Close()
sl@0: 	{
sl@0: 	if (iFsOpen)
sl@0: 		{
sl@0: 		iFs.Close();
sl@0: 		iFsOpen = EFalse;
sl@0: 		}
sl@0: 	}