// Copyright (c) 1997-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:

// ConArc plug-in converter.

// Converts EPOC Rich Text files (i.e. externalised CRichText objects) to HTML files.

// 1. Does not support object->object conversions

// 2. Therefore does not support embedded objects

// 3. No output encoding for UNICODE has beed decided upon

// 

//

#include <e32base.h>

#include <e32def.h>

#include <e32std.h>

#include <s32file.h>

#include <txtuids.h>

#include <txtetext.h>

#include <txtrich.h>

#include <conarc.h>

#include <bautils.h>

#include "RT2HTMCV.H"

#include "HTMLDEFS.H"

#include <ecom/ecom.h>

#include <ecom/implementationproxy.h>

//-------------------------------------------------------------------------------------------------

const TInt  KMaxTagLength		= 256;

const TText KCharacterSpace		= 0x20;

//-------------------------------------------------------------------------------------------------

#ifdef _UNICODE

	HBufC8* ConvertUnicodeToUTF8LC(const TDesC16& uniText);

#endif // _UNICODE

_LIT(KTempFileExt, ".dat");

typedef TPckgBuf<CRichText*> TRTPtrBuffer;

/**

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

 The required ConArc classes: CCtrToHTMLConverter and CCrtToHTMLLibrary

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

 Class CCrtToHTMLConverter.

 The CConverterBase derived class which is responsable for performing the conversion operation.

 1. Supports File->File conversions and output to a RWriteStream

 2. For the stream interface a temporary file store is created for reading the rich text object.

    this is deleted once the conversion is complete

 3. The conversion is performed on a paragraph by paragraph basis

 4. iHTMLOut is used to output the resulting HTML. For File->File conversions a new file stream store

    is opened based on the user provided file name. For the streaming interface iHTMLOut is assigned 

    to a RWriteStream& provided by the user

*/

CCrtToHTMLConverter::CCrtToHTMLConverter() : iHTMLOut(iFileStream)

	{ 

	}

void CCrtToHTMLConverter::ConvertL(const TFileName& aSourceFile, const TFileName& aTargetFile, MConverterUiObserver* aObserver /*= NULL*/)

//

// Configures and performs a file -> file conversion synchronously

//

	{

	iObserver = aObserver;

	PrepForConversionL(aSourceFile, aTargetFile);

	while(DoConvertL())

		{

		}

	ASSERT(iParaRemain == 0);

	}

void CCrtToHTMLConverter::ConvertAL(const TFileName& aSourceFile, const TFileName& aTargetFile, MConverterUiObserver* aObserver /*= NULL*/)

//

// Configures the object to perform a file -> file conversion asynchronously

//

	{

	// Cast away the const-ness - for now...

	iObserver = aObserver;

	PrepForConversionL(aSourceFile, aTargetFile);

	if(iObserver)

		{

		iObserver->MaxSteps(iParaRemain, 0);

		}

	}

/**

 To create the RReadStream you package a pointer to the CRichText object and create a RDesReadStream:

 TPckgBuf<CRichText*> buffer(text); //text is the CRichText* to be converted

 RDesReadStream readStream(buffer); //readStream can now be passed to ConvertObjectL/ConvertObjectAL

*/

void CCrtToHTMLConverter::ConvertObjectL(RReadStream& aReadStream, RWriteStream& aWriteStream, MConverterUiObserver* aObserver)

	{

	iObserver = aObserver;

	PrepForConversionL(aReadStream, aWriteStream);

	while(DoConvertL());

	ASSERT(iParaRemain == 0);

	}

/**

 To create the RReadStream you package a pointer to the CRichText object and create a RDesReadStream:

 TPckgBuf<CRichText*> buffer(text); //text is the CRichText* to be converted

 RDesReadStream readStream(buffer); //readStream can now be passed to ConvertObjectL/ConvertObjectAL

*/

void CCrtToHTMLConverter::ConvertObjectAL(RReadStream& aReadStream, RWriteStream& aWriteStream, MConverterUiObserver* aObserver)

	{

	iObserver = aObserver;

	PrepForConversionL(aReadStream, aWriteStream);

	if(iObserver)

		{

		iObserver->MaxSteps(iParaRemain, 0);

		}

	}

TUid CCrtToHTMLConverter::Uid()

//

// Returns the UID associated with the conversion operation

//

	{

	return KCrt2HTMLConverterUid;

	}

TInt CCrtToHTMLConverter::Capabilities()

//

// Returns EConvertsFiles. Only File->File conversion is supported.

//

	{

	return EConvertsFiles;

	}

void CCrtToHTMLConverter::CancelConvert()

//

// Clean up. Doesn't remove half finished file.

//

	{

	ResetMembers();

	}

CCrtToHTMLConverter::~CCrtToHTMLConverter()

	{

	ResetMembers();

	iFs.Close();

	}

/**

 Performs a single step of the conversion. Converts a single paragraph from Rich Text -> HTML

 THe final aparagrahp of a RichText doc contains a single end of document marker. When we 

 reach this we can delete the output sink object, which will flush and close the output file.

*/

TBool CCrtToHTMLConverter::DoConvertL()

	{

	TBool closePara = ETrue;

	if(iParaNum == -1)				// We're at the start

		{

		StartDocumentL();			// Write the HTML header

	    iParaNum   = 0;

	    iParaLen   = 0;

		iParaPos   = 0;

		closePara  = EFalse;		// Coz we don't want a </P> tag a the start...

		}	

	// Do a single paragraph...

	if((iParaPos = iInputText->CharPosOfParagraph(iParaLen, iParaNum++)) >= 0)

		{

		// Construct a formatting object

		CParaFormat* format = CParaFormat::NewLC();

		TParaFormatMask  mask;

		// Cue, Mr Hack...

		// Knock 1 off the document length as a panic prevention measure, as the iParaLength of

		// the last paragraph is _beyond_ the end of the document. Doh!

		if(iParaNum == iParaCount)

			iParaLen -= 1;

		iInputText->GetParaFormatL(format, mask, iParaPos, iParaLen);

		ASSERT(mask.IsNull());

		ProcessParagraphFormatL(format, closePara);	// Put paragraph level formatting

		ProcessParagraphTextL(iParaPos, iParaLen);	// Process the paragraph itself

		--iParaRemain;

		CleanupStack::PopAndDestroy(); // CParaFormat format

		if(iParaNum == iParaCount)  // We're at the end of the document, so finish up

			{

			ASSERT(iParaPos + iParaLen == iInputText->DocumentLength());

			EndDocumentL();

			// Commit the file

			iHTMLOut.CommitL();

			iHTMLOut.Close();

			return EFalse;

			}

		}

	else

		{

		Panic(EHTMLBeyondLastPara);

		}

	return ETrue;

}

/**

 Both File->File and stream converstions use a file store to read the input CRichText object

 In File->File conversions the user creates the rich text file store prior to calling ConvertL()/ConvertAL()

 In stream conversions CCrtToHTMLConverter creates a temporary file store

*/

void CCrtToHTMLConverter::RestoreInputTextL(const TFileName& aSourceFile)

	{

	delete iInputText;

	iInputText = NULL;

	iParaLayer = CParaFormatLayer::NewL();

	iCharLayer = CCharFormatLayer::NewL();

	iInputText = CRichText::NewL(iParaLayer, iCharLayer, CEditableText::EFlatStorage);

	// Get the store and restore from it to the CRichText object

	iStore = CDirectFileStore::OpenL(iFs, aSourceFile, EFileRead | EFileShareReadersOnly);

	if(iStore->Type()[0] != KDirectFileStoreLayoutUid)

          User::Leave(KErrUnknown);     

   	iInputText->RestoreL(*iStore, iStore->Root());

	iParaRemain = iInputText->ParagraphCount();

	iParaCount  = iParaRemain;

	}

/**

  Configures the object prior to performing a conversion. 

  1. Connects to the file server

  2. Restores the input CRichText object from the given file

  3. Prepares the output context

*/

void CCrtToHTMLConverter::PrepForConversionL(const TFileName& aSourceFile, const TFileName& aTargetFile)

	{

	ResetMembers();

	// ResetMembers() will close the file server session to ensure it's flushed and any temporary files are deleted 

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

	iHTMLOut = iFileStream;

	RestoreInputTextL(aSourceFile);

	// Set up the output context

	User::LeaveIfError(((RFileWriteStream&)iHTMLOut).Replace(iFs, aTargetFile, EFileStream|EFileWrite|EFileShareExclusive));

	}

/**

  Configures the object prior to performing a conversion. 

  1. Connects to the file server

  2. Assign the output stream

  3. Copys the read CRichText object to a file store

  4. Restores our copy of the input CRichText

 There's no way to copy a CRichText object without first externalizing it in some way. The normal mechanism for 

 saving and loading CRichText objects is to use Store and Restore. Using Externalize and Internalize is non-trivial

 with CRichText. The stream interface only gives us a RReadStream& making Restore very difficult. The way around 

 this is for the user to just stream a pointer to the actual CRichText object. This way the caller dosn't need to 

 worry about setting up any stores. CCrtToHTMLConverter does the copy.

 To create the RReadStream you package a pointer to the CRichText object and create a RDesReadStream:

 TPckgBuf<CRichText*> buffer(text); //text is the CRichText* to be converted

 RDesReadStream readStream(buffer); //readStream can now be passed to ConvertObjectL/ConvertObjectAL

*/ 

void CCrtToHTMLConverter::PrepForConversionL(RReadStream& aReadStream, RWriteStream& aWriteStream)

	{

	ResetMembers();

	// ResetMembers() will close the file server session to ensure it's flushed and any temporary files are deleted 

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

	iHTMLOut = aWriteStream;

	// Unpackage the source rich text pointer

	TRTPtrBuffer readBuffer;

	aReadStream.ReadL(readBuffer);

	CRichText* sourceText = readBuffer();

	// The temporary file needs to be unique to allow for concurrent conversions

	// This file is deleted on a call to ResetMembers()

	TFileName newTempFile;

	User::LeaveIfError(iFs.PrivatePath(newTempFile));

	newTempFile.AppendNum((TInt)sourceText);

	newTempFile.Append(KTempFileExt);

	BaflUtils::EnsurePathExistsL(iFs, newTempFile);

	iInternalFile = newTempFile.AllocL();

	CDirectFileStore* fileStore = CDirectFileStore::ReplaceL(iFs, *iInternalFile, EFileWrite|EFileShareAny);

	CleanupStack::PushL( fileStore );

	fileStore->SetTypeL( KDirectFileStoreLayoutUid );

	TStreamId streamID = sourceText->StoreL(*fileStore);

	fileStore->SetRootL(streamID);

	fileStore->CommitL();

	CleanupStack::PopAndDestroy( fileStore );

	// Restore our copy of the input rich text object from the newly created file store

	RestoreInputTextL(*iInternalFile);

	}

/**

 Ensures that any contained objects are desstroyed and sets all member variable to zero(NULL)

*/

void CCrtToHTMLConverter::ResetMembers()

	{

	iStyleIndex = -1;

	iParaNum    = -1;

	iParaLen    = 0;

	iParaPos    = 0;

	iParaCount  = 0;

	iParaRemain = 0;

	iIndent     = 0;

	iOldFmtCount = 0;

	iHTMLOut.Close();

	delete iInputText;

	iInputText = NULL;

	delete iParaLayer;

	iParaLayer = NULL;

	delete iCharLayer;

	iCharLayer = NULL;

	delete iBullet;

	iBullet = NULL;

	delete iStore;

	iStore = NULL;

	if (iFs.Handle()) 

		{

		if (iInternalFile && BaflUtils::FileExists(iFs,*iInternalFile))

			{

			iFs.Delete(*iInternalFile);

			delete iInternalFile;

			iInternalFile = NULL;			

			}

		// I'm closing the file server to ensure it flushes.

		// Otherwise internal files are not always deleted

		iFs.Close();

		}

	}

/**

 Scans the passed buffer, replacing special characters in the source with relevant HTML tags

 before sending them to be output

*/

void CCrtToHTMLConverter::TranslateL(const TDesC& aBuf)

	{

	int i = 0;

	while(i < aBuf.Length())

		{

		TText ch = aBuf[i++];

		switch(ch)

			{

			// !! am I picking up all possibles here?

			case CEditableText::EPageBreak:

			case CEditableText::EPotentialHyphen:

			case CEditableText::ENonBreakingHyphen:

				break;  // These characters are not emitted.

			case CEditableText::EPictureCharacter:

				break;

			case CEditableText::ELineBreak:

				WriteTagL(KHtmlLineBreak);

				break;

			case CEditableText::ENonBreakingSpace:

			case CEditableText::ETabCharacter:

				WriteContentL(TPtrC(&KCharacterSpace, 1));

				break;

			case CEditableText::EParagraphDelimiter:

				break;

			case KLessThan:

				WriteTagL(KHtmlLessThan);

				break;

			case KGreaterThan:

				WriteTagL(KHtmlGreaterThan);

				break;

			case KAmpersand:

				WriteTagL(KHtmlAmpersand);

				break;

			default:

				WriteContentL(TPtrC(&ch, 1));

				break;

			}

		}

	}

void CCrtToHTMLConverter::WriteTagL(const TDesC8& aTagText)

	{

	iHTMLOut.WriteL(aTagText);

	}

void CCrtToHTMLConverter::WriteContentL(const TDesC& aText)

	{

#ifdef _UNICODE

	HBufC8* pBuf = ConvertUnicodeToUTF8LC(aText);

	User::LeaveIfNull(pBuf);

	iHTMLOut.WriteL(*pBuf);

	CleanupStack::PopAndDestroy();

#else

	iHTMLOut.WriteL(aText);

#endif

	}

void CCrtToHTMLConverter::ProcessParagraphFormatL(const CParaFormat* aFormat, TBool aClosePara)

//

// Processes any paragraph level formatting (paragraph alignment, list bullets, indentation)