sl@0: // Copyright (c) 1997-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: /**
sl@0:  @file
sl@0:  @internalComponent
sl@0: */
sl@0: 
sl@0: #include "FLOGMAN.H"
sl@0: #include "FLOGSTD.H"
sl@0: 
sl@0: const TInt KLoggerGranularity=5;
sl@0: 
sl@0: /**
sl@0: Literal const that hold back slash.
sl@0: */
sl@0: const TText KBackSlash='\\';
sl@0: 
sl@0: /**
sl@0: full path for log folder
sl@0: */
sl@0: _LIT(KLogFolder,"C:\\LOGS\\");
sl@0: 
sl@0: /**
sl@0: CFileLoggerManager definitions
sl@0: */
sl@0: 
sl@0: CFileLoggerManager* CFileLoggerManager::NewL()
sl@0: /**
sl@0: Creates a new CFileLoggerManager Object 
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	CFileLoggerManager* r=new(ELeave) CFileLoggerManager();
sl@0: 	CleanupStack::PushL(r);
sl@0: 	r->ConstructL();
sl@0: 	CleanupStack::Pop();
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: CFileLoggerManager::~CFileLoggerManager()
sl@0: /**
sl@0: Destructor
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TInt i;
sl@0: 	TInt count=iLogger.Count();
sl@0: 	for (i=0; i<count; i++)
sl@0: 		{	
sl@0: 		delete iLogger[i];
sl@0: 		iLogger[i]=NULL;
sl@0: 		}
sl@0: 
sl@0: 	iLogger.Delete(0,count);
sl@0: 	iFs.Close();
sl@0: 	}
sl@0: 
sl@0: CFileLoggerManager::CFileLoggerManager()
sl@0: 	: iLogger(KLoggerGranularity)
sl@0: /**
sl@0: Default Constructor 
sl@0: */
sl@0: 	{}
sl@0: 
sl@0: void CFileLoggerManager::ConstructL()
sl@0: 	{
sl@0: 
sl@0: 	User::LeaveIfError(iFs.Connect());
sl@0: 	}
sl@0: 
sl@0: void CFileLoggerManager::FindOrCreateLogL(TLogFile& aLogFile)
sl@0: /**
sl@0: Searches the log file. If not found create it otherwise just
sl@0: increment access count.
sl@0: 
sl@0: @param aLogFile Name of log file
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TInt indexFound=FindLogger(aLogFile);	
sl@0: 	if (indexFound!=KErrNotFound)
sl@0: 		{
sl@0: 		iLogger[indexFound]->CancelDeletionTimer();
sl@0: 		iLogger[indexFound]->IncrementAccessCount();
sl@0: 		aLogFile.SetValid(iLogger[indexFound]->LogFile().Valid());
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	CFileLogger* log=CFileLogger::NewL(this,aLogFile,iFs);
sl@0: 	CleanupStack::PushL(log);
sl@0: 	iLogger.AppendL(log);
sl@0: 	CleanupStack::Pop();
sl@0: 	}
sl@0: 
sl@0: void CFileLoggerManager::CloseLog(const TLogFile& aLogFile)
sl@0: /**
sl@0: Searches the log file, if not found return. Decrement the access
sl@0: count and check for the client usage. If no client is using it 
sl@0: any more, delete the log file.
sl@0: 
sl@0: @param aLogFile Name of log file
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TInt indexFound=FindLogger(aLogFile);
sl@0: 	if (indexFound==KErrNotFound)
sl@0: 		return;
sl@0: 
sl@0: 	if (!iLogger[indexFound]->DeletionTimerActive())
sl@0: 		{
sl@0: 		iLogger[indexFound]->DecrementAccessCount();
sl@0: 
sl@0: 		if (iLogger[indexFound]->AccessCount()==0)	// if no client is using it any more
sl@0: 			{
sl@0: 			TBool started=iLogger[indexFound]->StartDeletionTimer();
sl@0: 			if (!started)
sl@0: 				{
sl@0: 				delete iLogger[indexFound];
sl@0: 				iLogger.Delete(indexFound,1);
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CFileLoggerManager::WriteToLogL(const TLogFile& aLogFile, const TDesC8& aBuf)
sl@0: /**
sl@0: Searches and Writes to log file.
sl@0: 
sl@0: @param aLogFile Name of log file
sl@0: @param aBuf Text to write
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TInt indexFound=FindLogger(aLogFile);
sl@0: 	if (indexFound==KErrNotFound)
sl@0: 		{
sl@0: 		User::Leave(KErrNotFound);
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	iLogger[indexFound]->WriteLogL(aBuf);
sl@0: 	}
sl@0: 
sl@0: void CFileLoggerManager::DeleteLogger(CFileLogger* aLogger)
sl@0: 	{
sl@0: 
sl@0: 	TInt index=FindLogger(aLogger->LogFile());
sl@0: 	__ASSERT_DEBUG(index!=KErrNotFound, User::Invariant());
sl@0: 	if (index!=KErrNotFound)
sl@0: 		{
sl@0: 		delete iLogger[index];
sl@0: 		iLogger.Delete(index,1);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: TInt CFileLoggerManager::FindLogger(const TLogFile& aLogFile) const
sl@0: /**
sl@0: Searches log file.
sl@0: @param aLogFile Name of the log file
sl@0: */
sl@0: 	{
sl@0: 	
sl@0: 	TInt i;
sl@0: 	TInt indexFound=KErrNotFound;
sl@0: 	for (i=0; i<iLogger.Count(); i++)
sl@0: 		{
sl@0: 		if (iLogger[i]->LogFile()==aLogFile)
sl@0: 			{
sl@0: 			indexFound=i;
sl@0: 			break;
sl@0: 			}
sl@0: 		}
sl@0: 	return indexFound;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: CFileLogger defintions
sl@0: */
sl@0: 
sl@0: CFileLogger* CFileLogger::NewL(CFileLoggerManager* aLoggerManager,TLogFile& aLogFile, RFs& aFs)
sl@0: /**
sl@0: Creates CFileLogger
sl@0: 
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	CFileLogger* r=new(ELeave) CFileLogger(aLoggerManager,aLogFile,aFs);
sl@0: 	CleanupStack::PushL(r);
sl@0: 	r->ConstructL(aLogFile);
sl@0: 	CleanupStack::Pop();
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: CFileLogger::~CFileLogger()
sl@0: /**
sl@0: Destructor
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	__ASSERT_DEBUG(iAccessCount==0, User::Invariant());
sl@0: 	iFile.Close();
sl@0: 	delete iTimer;
sl@0: 	}	
sl@0: 
sl@0: CFileLogger::CFileLogger(CFileLoggerManager* aLoggerManager,TLogFile& aLogFile, RFs& aFs)
sl@0: 	: iLoggerManager(aLoggerManager), iFs(aFs), iLogFile(aLogFile), iAccessCount(0)
sl@0: /**
sl@0: Access count will be incremented when construcion is complete
sl@0: 
sl@0: */
sl@0: 	{}
sl@0: 
sl@0: void CFileLogger::ConstructL(TLogFile& aLogFile)
sl@0: /**
sl@0: Decide whether to create a log (only create a log if the folder exists) and if 
sl@0: so delete any existing one, if the mode is overwirte, append to any existing one 
sl@0: if the mode is append. Open or create and the file and position to the end of it.
sl@0: If an error occurs, the iValid flag will just be left as FALSE, as initialised.
sl@0: 
sl@0: @param aLogFile Name of the log file
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iTimer=CLoggerDeletionTimer::NewL(this);
sl@0: 
sl@0: 	iLogFile.SetValid(EFalse);
sl@0: 	aLogFile.SetValid(EFalse);
sl@0: 
sl@0: 	TFileName logFolder,logFilename;
sl@0: 	GetFolderAndFileNameL(logFolder,logFilename);
sl@0: 	
sl@0: 	TUint n;
sl@0: 	if (iFs.Att(logFolder,n)==KErrNone)		// the folder exists => do logging
sl@0: 		{
sl@0: 		TInt ret=KErrNone;
sl@0: 		TBool fileExists=EFalse;
sl@0: 		if (iLogFile.Mode()==EFileLoggingModeOverwrite)
sl@0: 			{
sl@0: 			ret=iFs.Delete(logFilename);
sl@0: 			if (ret!=KErrNotFound && ret!=KErrNone)
sl@0: 				User::Leave(ret);
sl@0: 			}
sl@0: 		else		// append
sl@0: 			{
sl@0: 			if (iFs.Att(logFilename,n)==KErrNone)
sl@0: 				fileExists=ETrue;
sl@0: 			}
sl@0: 
sl@0: 		if (!fileExists)
sl@0: 			ret=iFile.Create(iFs,logFilename,EFileShareAny|EFileWrite);
sl@0: 		else
sl@0: 			ret=iFile.Open(iFs,logFilename,EFileShareAny|EFileWrite);
sl@0: 		if (ret==KErrNone)	// if we managed to open/create it
sl@0: 			{
sl@0: 			TInt pos=0;
sl@0: 			ret=iFile.Seek(ESeekEnd,pos);
sl@0: 			if (ret==KErrNone)
sl@0: 				{
sl@0: 				iLogFile.SetValid(ETrue);
sl@0: 				aLogFile.SetValid(ETrue);
sl@0: 				IncrementAccessCount();
sl@0: 				return;
sl@0: 				}
sl@0: 			}
sl@0: 		iFile.Close();
sl@0: 		User::Leave(ret);
sl@0: 		}
sl@0: 	IncrementAccessCount();
sl@0: 	}
sl@0: 
sl@0: void CFileLogger::WriteLogL(const TDesC8& aBuf)
sl@0: /**
sl@0: Checks for log file and then Writes the text
sl@0: 
sl@0: @param aBuf Text to write
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	if (iLogFile.Valid())
sl@0: 		{
sl@0: 		User::LeaveIfError(iFile.Write(aBuf));
sl@0: 		User::LeaveIfError(iFile.Flush());
sl@0: 		}
sl@0: 	}	
sl@0: 
sl@0: TBool CFileLogger::StartDeletionTimer()
sl@0: /**
sl@0: Starts timer if this was a valid log file (i.e. it was open)
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	if (!iLogFile.Valid())
sl@0: 		return EFalse;
sl@0: 	iTimer->After(KShutdownPause);
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: void CFileLogger::CancelDeletionTimer()
sl@0: /**
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iTimer->Cancel();
sl@0: 	}
sl@0: 
sl@0: void CFileLogger::DeletionTimerExpired()
sl@0: /**
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iLoggerManager->DeleteLogger(this);
sl@0: 	}
sl@0: 
sl@0: void CFileLogger::GetFolderAndFileNameL(TFileName& aFolder,TFileName& aFilename) const
sl@0: /**
sl@0: Work out the full path of the folder and file name of the log
sl@0: 
sl@0: @param aFolder Full path of log file
sl@0: @param aFilename Name of log file
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	aFolder.Append(KLogFolder);
sl@0: 	if ((aFolder.MaxLength()-aFolder.Length()-iLogFile.Directory().Length()-1)>=0)
sl@0: 		{
sl@0: 		aFolder.Append(iLogFile.Directory());
sl@0: 		aFolder.Append(KBackSlash);
sl@0: 		}
sl@0: 	else
sl@0: 		User::Leave(KErrOverflow);
sl@0: 
sl@0: 	if ((aFilename.MaxLength()-aFolder.Length()-iLogFile.Name().Length())>=0)
sl@0: 		{
sl@0: 		aFilename.Append(aFolder);
sl@0: 		aFilename.Append(iLogFile.Name());
sl@0: 		}
sl@0: 	else
sl@0: 		User::Leave(KErrOverflow);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: CLoggerDeletionTimer class definitions
sl@0: */
sl@0: 
sl@0: CLoggerDeletionTimer* CLoggerDeletionTimer::NewL(CFileLogger* aLogger)
sl@0: /**
sl@0: Creates CLoggerDeletionTimer
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	CLoggerDeletionTimer* r=new(ELeave) CLoggerDeletionTimer(aLogger);
sl@0: 	CleanupStack::PushL(r);
sl@0: 	r->ConstructL();
sl@0: 	CleanupStack::Pop();
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: CLoggerDeletionTimer::~CLoggerDeletionTimer()
sl@0: /**
sl@0: Destructor
sl@0: */
sl@0: 	{}
sl@0: 
sl@0: CLoggerDeletionTimer::CLoggerDeletionTimer(CFileLogger* aLogger)
sl@0: 	: CTimer(EPriorityIdle), iLogger(aLogger)
sl@0: 	{
sl@0: 	CActiveScheduler::Add(this);
sl@0: 	}
sl@0: 
sl@0: void CLoggerDeletionTimer::RunL()
sl@0: 	{
sl@0: 	
sl@0: 	iLogger->DeletionTimerExpired();
sl@0: 	}