/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

* 

* Description: This module contains implementation of CFileOutput 

* class member functions.

*

*/

// INCLUDE FILES

#include "FileOutput.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES  

// None

// CONSTANTS

// None

// MACROS

// None

//#define RDEBUG_FILEWRITECRASH(a) RDebug::Print(a)

#define RDEBUG_FILEWRITECRASH(a)

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

// ==================== LOCAL FUNCTIONS =======================================

// None

// ================= MEMBER FUNCTIONS =========================================

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: CFileOutput

    Description: Default constructor

    C++ default constructor can NOT contain any code, that

    might leave.

    Parameters: TLoggerType aLoggerType: in: File type

                TBool aWithTimeStamp: in: For timestamp

                TBool aWithLineBreak: in: For line break

                TBool aWithEventRanking: in: For events ranking to file

                TBool aThreadIdToLogFile: in: Indicator to thread id adding to

                                              end of the log file

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CFileOutput::CFileOutput( CStifLogger::TLoggerType aLoggerType,

                            TBool aWithTimeStamp,

                            TBool aWithLineBreak,

                            TBool aWithEventRanking,

                            TBool aThreadIdToLogFile ) :

    COutput()

    {

    // Indicates file type

    iLoggerType = aLoggerType;

    // Time stamp indicator

    iWithTimeStamp = aWithTimeStamp;

    // Line break indicator

    iWithLineBreak = aWithLineBreak;

    // Log event ranking indicator

    iWithEventRanking = aWithEventRanking;

    // Indicator to thread id adding to end of the log file

    iThreadIdToLogFile = aThreadIdToLogFile;

    // Is file open indicator

    iIsFileOpen = 0;

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: const TDesC& aTestPath: in: Log path

                const TDesC& aTestFile: in: Log filename

                TBool aOverWrite: in: For file overwrite

                TBool aCreateLogDir: in: Indicator to directory creation

                TInt  aStaticBufferSize

                TBool aUnicode: in: Indicator if file has to be in unicode format

    Return Values: None

    Errors/Exceptions:  Leaves if called CreateNewFileL method fails

                        Leaves if called OpenExistingFileL method fails

    Status: Proposal

-------------------------------------------------------------------------------

*/

void CFileOutput::ConstructL( const TDesC& aTestPath,

                                const TDesC& aTestFile,

                                TBool aOverWrite,

                                TBool aCreateLogDir,

                                TInt aStaticBufferSize,

                                TBool aUnicode)

    {

    iUnicode = aUnicode;

    // Open file session

    User::LeaveIfError( iFileSession.Connect() );

    // Create a log directory

    if( aCreateLogDir )

        {

        CreateDirectoryL( aTestPath );

        }

    // Create a new file

    if ( aOverWrite )

        {

        CreateNewFileL( aTestPath, aTestFile );

        }

    // Open an existing file

    else 

        {

        OpenExistingFileL( aTestPath, aTestFile );

        }

    if( aStaticBufferSize != 0)

        {

        iDataHBuf8 = HBufC8::NewL( aStaticBufferSize );

        iDataHBuf16 = HBufC::NewL(aStaticBufferSize);

        iStaticBufferSize = aStaticBufferSize;

        }

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: NewL

    Description: Two-phased constructor.

    Parameters: const TDesC& aTestPath: in: Log path

                const TDesC& aTestFile: in: Log filename

                TLoggerType aLoggerType: in: File type

                TBool aOverWrite: in: For file overwrite

                TBool aWithTimeStamp: in: For timestamp

                TBool aWithLineBreak: in: For line break

                TBool aWithEventRanking: in: For events ranking to file

                TBool aThreadIdToLogFile: in: Indicator to thread id adding to

                                              end of the log file

                TBool aCreateLogDir: in: Indicator to directory creation

                TInt  aStaticBufferSize

                TBool aUnicode: in: Indicator if file has to be in unicode format

    Return Values: CFileOutput*: pointer to CFileOutput object

    Errors/Exceptions: Leaves if ConstructL leaves

    Status: Proposal

-------------------------------------------------------------------------------

*/

CFileOutput* CFileOutput::NewL( const TDesC& aTestPath,

                                const TDesC& aTestFile,

                                CStifLogger::TLoggerType aLoggerType,

                                TBool aOverWrite,

                                TBool aWithTimeStamp,

                                TBool aWithLineBreak,

                                TBool aWithEventRanking,

                                TBool aThreadIdToLogFile,

                                TBool aCreateLogDir,

                                TInt  aStaticBufferSize,

                                TBool aUnicode )

    {

    // Create CFileOutput object fileWriter

    CFileOutput* fileWriter = new (ELeave) CFileOutput( aLoggerType,

                                                        aWithTimeStamp,

                                                        aWithLineBreak,

                                                        aWithEventRanking,

                                                        aThreadIdToLogFile );

    CleanupStack::PushL( fileWriter );

    fileWriter->ConstructL( aTestPath, aTestFile, aOverWrite, aCreateLogDir, aStaticBufferSize,

                            aUnicode );

    CleanupStack::Pop( fileWriter );

    return fileWriter;

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: ~CFileOutput

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CFileOutput::~CFileOutput()

    {

    // Close file

    iFile.Close();

    // Close file session

    iFileSession.Close();

    delete iDataHBuf8;

    delete iDataHBuf16;

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: FileType

    Description: Check file type.

    Check is file type set with a aTestFile's name. If file type is not set

    the type will set according to StifLogger's type.

    Parameters: const TDesC& aTestFile: in: Log filename

                TFileType& fileType: inout: Generated file type

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/    

void CFileOutput::FileType( const TDesC& aTestFile,

                            TFileType& aFileType )

    {

    TBool fileTypeIsSet( EFalse ); // File type indicator

    // Check is file type set to aTestFile parameter

    TInt ret = aTestFile.Find( _L( "." ) );

    if( ret != KErrNotFound )

        {

        fileTypeIsSet = ETrue;

        }

    // If not, add thread id name if allowed

    else if ( iThreadIdToLogFile )

        {

        // Thread id maximum length is 8 in hexadesimal format

        // Construct unique thread name

        aFileType.Append( _L("_") );

        RThread threadHandle;                   // A handle to a thread

        TThreadId id = threadHandle.Id();       // Encapsulates the 

                                                // Id of a thread

        // Appends id in hexadesimal format             

        aFileType.AppendFormat( _L( "%x" ), (TInt)id );

        }

    // Add file type after the thread id name

    if ( iLoggerType == CStifLogger::ETxt && !fileTypeIsSet )

        {

        // ".txt"

        aFileType.Append( _L( "." ) );

        aFileType.Append( _L( "txt" ) );

        }

    else if ( iLoggerType == CStifLogger::EHtml && !fileTypeIsSet )

        {

        // ".html"

        aFileType.Append( _L( "." ) );

        aFileType.Append( _L( "html" ) );

        }

    // EData file type comes from the aTestFile name. If not the file type 

    // will be empty

    else if ( iLoggerType == CStifLogger::EData )

        {

        aFileType.Append( _L( "" ) );

        }

    else

        {

        aFileType.Append( _L( "" ) );

        }

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: TestFileWithThreadId

    Description: Generate thread id

    Generate thread id name between the test file name and test file type.

    Parameters: TDesC& aTestFile: in: Test file name

                TFileName& aNewTestFile: inout: Generated test file name 

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CFileOutput::TestFileWithThreadId( const TDesC& aTestFile, 

                                        TFileName& aNewTestFile )

    {

    for( TInt a = 0; a < aTestFile.Length(); a++ )

        {

        // Find a dot

        if( aTestFile[a] == '.' )

            {

            TPtrC parsedFileType = aTestFile.Mid( a );  // Take rest of the 

                                                        // aTestFile

            aNewTestFile.Append( _L( "_" ) );

            RThread threadHandle;                       // A handle to a thread

            TThreadId id = threadHandle.Id();           // Encapsulates the 

                                                        // Id of a thread

            aNewTestFile.AppendFormat( _L( "%x" ), (TInt)id );// Appends id in

                                                        // hexadesimal format

            aNewTestFile.Append( parsedFileType );

            break;

            }

        // Dot not found yet

        else

            {

            aNewTestFile.Append( aTestFile[a] );

            }

        }

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: CreateDirectoryL

    Description: Create a log directory.

    Method creates directory if not allready exist.

    Parameters: const TDesC& aTestPath: in: Test path definition

    Return Values: None

    Errors/Exceptions: Leaves if directory creation fails

    Status: Proposal

-------------------------------------------------------------------------------

*/

void CFileOutput::CreateDirectoryL( const TDesC& aTestPath )

    {

    __TRACE( KInfo, ( _L( "STIFLOGGER: Create a directory" ) ) );

    TInt ret = iFileSession.MkDirAll( aTestPath );

	if( ret != KErrNone && ret != KErrAlreadyExists )

        {

        __TRACE( KError, 

            ( _L( "STIFLOGGER: Directory creation fails with error: %d" ), ret ) );

		User::Leave( ret );

        }

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: OpenExistingFileL

    Description: Open an existing file.

    Method is used when is need for log new information after the existing

    log file.

    Parameters: const TDesC& aTestPath: in: Test path definition

                const TDesC& aTestFile: in: Test file name

    Return Values: None

    Errors/Exceptions:  Leaves if path or file lengths are over KMaxFileName

                        Leaves if file Replace method fails

                        Leaves if file Open method fails

                        Leaves if file path not found

    Status: Proposal

-------------------------------------------------------------------------------

*/

void CFileOutput::OpenExistingFileL( const TDesC& aTestPath, 

                                        const TDesC& aTestFile )

    {

    __TRACE( KInfo, ( _L( "STIFLOGGER: Opening an existing file for logging" ) ) );

    // If path and file name lengths are over KMaxFileName(TFileName)

    __ASSERT_ALWAYS(

        ( aTestPath.Length() + aTestFile.Length() ) < KMaxFileName,

        User::Leave( KErrArgument ) );

    // Check file type and generate threat id name

    TFileType fileType;

    FileType( aTestFile, fileType );

    // File directory name, file name and file type definitions

    TPtrC dirNamePrt( aTestPath );

    iFileAndDirName.Copy( dirNamePrt );

    TInt isDotFound = aTestFile.Find( _L( "." ) );

    // If dot is found and iThreadIdToLogFile is true

    if( isDotFound != KErrNotFound && iThreadIdToLogFile )

        {

        TFileName testFileWithThreadId;

        // Generate thread id name

        TestFileWithThreadId( aTestFile, testFileWithThreadId );

        iFileAndDirName.Insert( 

            iFileAndDirName.Length(), testFileWithThreadId );

        }

    else

        {

        TPtrC txtPrt( fileType );

        iFileAndDirName.Insert( iFileAndDirName.Length(), aTestFile );

        iFileAndDirName.Insert( iFileAndDirName.Length(), txtPrt );

        }

    TBool isOpen( EFalse );

    TInt ret( KErrNone );

    iIsFileOpen = iFileSession.IsFileOpen( iFileAndDirName, isOpen );

    if( iIsFileOpen == KErrNotFound )

        {

        ret =  iFile.Create( iFileSession, iFileAndDirName, 

                                    EFileWrite | EFileStreamText |

                                    EFileShareAny );

        if(iUnicode && ret == KErrNone)

            {

            char FF = 0xFF;

            char FE = 0xFE;

            TBuf8<2> beg;

            beg.Append(FF);

            beg.Append(FE);

            if(iFile.Write(beg) == KErrNone)

                iFile.Flush();

            }

        }

    else if( iIsFileOpen == KErrNone )

        {

        ret = iFile.Open( iFileSession, iFileAndDirName,

                            EFileWrite | EFileStreamText |

                                    EFileShareAny );

        }

    // Probably path not found

    else

        {

        User::Leave( iIsFileOpen );

        }

    if ( ret != KErrNone )

        {

        User::Leave( ret );

        }

    }

/*

-------------------------------------------------------------------------------

    Class: CFileOutput

    Method: CreateNewFileL

    Description: Create a new file.

    Method creates new file to the log information.