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

// MSVSTORE.CPP

//

#include <txtrich.h>

#include "MSVSTD.H"

#include "MSVSTORE.H"

#include "MSVPANIC.H"

#include "CMsvCachedStore.h"

#include <cmsvplainbodytext.h>

#include "CMsvAttachmentManager.h"

#include <cmsvattachment.h>

#include <charconv.h>

#include <escapeutils.h>

#include <mmsvstoremanager.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS  

#include "msvconsts.h"

#endif

//

// CMsvStore

//

const TUint8 KCarriageReturn = 0x0D;

const TUint8 KLineFeed       = 0x0A;

EXPORT_C CMsvStore::~CMsvStore()

//

//

//

/** Destructor.

If the message store is currently locked, the destructor releases it before 

deleting the object. */

	{

	// tell the observer that this store is being released/closed

	if (iConstructed)

		{

		// only inform server if the store was successfully opened

		if (iLockStatus==EMsvStoreLocked)

			iObserver.HandleStoreEvent(MMsvStoreObserver::EMsvEditStoreClosed, iId);

		else

			iObserver.HandleStoreEvent(MMsvStoreObserver::EMsvReadStoreClosed, iId);

		}

	delete iAttachmentManager;

	delete iStore;

	delete iBodyText;

	}

EXPORT_C void CMsvStore::StoreBodyTextL(const CRichText& aRichTextBody)

//

// stores and commits body text to the file store, overwriting any existing data

// will panic if the store is unlocked and will leave if no store is found

//

/** Stores the body text stream of the message store. Any existing 

data is overwritten. Write access is needed for this function. A commit must be done

following this function for the new data to be retained.

@param aRichTextBody The body data to be externalised 

@leave KErrAccessDenied Store is not open for writing 

@leave Other Standard streaming leave codes */

	{

	if (iLockStatus==EMsvStoreUnlocked || iStore==NULL)

		User::Leave(KErrAccessDenied);

	iBodyText->RemoveL(*this);

	// Remove the body text data if stored in KMsvPlainBodyText8 or KMsvPlainBodyText16 format.

	if (IsPresentL(KMsvPlainBodyText8))

		{

		RemoveL(KMsvPlainBodyText8);

		}

	if (IsPresentL(KMsvPlainBodyText16))

		{

		RemoveL(KMsvPlainBodyText16);

		}

	RMsvWriteStream out;

	out.AssignL(*this,KMsvEntryRichTextBody);

	CEmbeddedStore* embeddedStore=CEmbeddedStore::NewLC(out);

	TStreamId streamId=aRichTextBody.StoreL(*embeddedStore);

	embeddedStore->SetRootL(streamId);

	embeddedStore->CommitL();

	CleanupStack::PopAndDestroy(); //embeddedstore

	}

void CMsvStore::Lock()

	{

	iLockStatus=EMsvStoreLocked;

	}

EXPORT_C TBool CMsvStore::IsNullL() const

/** Tests whether the message store contains any streams.

@return ETrue if the store has no streams, else EFalse

*/

	{

	return iStore->IsNullL();		

	}

EXPORT_C TBool CMsvStore::IsPresentL(TUid aUid) const

/** Tests whether the message store contains a stream identifier.

Do not use to check if there is a body text part stored with the email;

use CMsvStore::HasBodyTextL() instead.

@param aUid Identifier of stream 

@return ETrue if the store has a stream aUid, else EFalse 

 */

	{

	return iStore->IsPresentL(aUid);

	}

EXPORT_C TBool CMsvStore::HasBodyTextL() const

/** Checks if the store has a body text stream; IsPresentL(KMsvEntryRichTextBody)

will always return EFalse when the store_8bit_flag in imcm.rss is enabled.

@return ETrue if the store has a body text stream, else EFalse 

*/

	{

	return iStore->IsPresentL(KMsvEntryRichTextBody) || iBodyText->IsPresentL(*this)|| iStore->IsPresentL(KMsvPlainBodyText8)|| iStore->IsPresentL(KMsvPlainBodyText16);

	}

/**

Restores body text into the given rich text object - doesnt matter if store is locked or not

will leave if the file store doesn't exist, the body text does not exist, and also propagate store leaves

Reads the body text stream from the message store into the given rich text 

object. 

@param aRichTextBody 	On return, the message store's body text is inserted 

						into this object. Any previously existing contents is lost. 

@leave KErrNotFound 	There is no body text stream in the store 

@leave Other Standard streaming leave codes 

*/

EXPORT_C void CMsvStore::RestoreBodyTextL(CRichText& aRichTextBody)

	{

	// Charset set to 0 so that RestoreBodyTextL works as per existing published behaviour.

	RestoreBodyTextL(aRichTextBody, 0);

	}

/**

Restores body text into the given rich text object - doesnt matter if store is locked or not.

Reads the body text stream from the message store into the given rich text 

object.

@param aRichTextBody 		On return, the message store's body text is inserted 

							into this object. Any previously existing contents is lost. 

@param aCharsetOverride   	The charset with which to override the existing charset 

							when data is stored a 8 bit format. 

@leave KErrNotFound 		There is no body text stream in the store 

@leave Other Standard streaming leave codes 

*/

EXPORT_C void CMsvStore::RestoreBodyTextL(CRichText& aRichTextBody, TUint aCharsetOverride)

	{

	if (iStore==NULL )

		{

		User::Leave(KErrNotFound);

		}

	if (IsPresentL(KMsvEntryRichTextBody))

		{

		RMsvReadStream inputStream;

		inputStream.OpenL(*this, KMsvEntryRichTextBody); // CEmbeddedStore::FromLC() take ownership

		CEmbeddedStore* embeddedStore = CEmbeddedStore::FromLC(inputStream);

		aRichTextBody.RestoreL(*embeddedStore, embeddedStore->Root());

		CleanupStack::PopAndDestroy();	// embeddedStore

		}

	else if(iBodyText->IsPresentL(*this))

		{

		iBodyText->RestoreL(*this);

		// If a new charset was set, override the  restored charset

		// so that data is converted using new charset.

		if(aCharsetOverride != 0)

			{

			iBodyText->SetCharacterSet(aCharsetOverride);

			}

		iBodyText->GetBodyTextL(iFs, *this, aRichTextBody);

		}

	else

		{

		if(IsPresentL(KMsvPlainBodyText8) || IsPresentL(KMsvPlainBodyText16))

			{

			RestorePlainBodyTextL (aRichTextBody, aCharsetOverride);

			}

		else		

			{

			User::Leave(KErrNotFound);

			}

		}

	}

/**

Restores a CRichText object from the plain body text file.

@param aRichText 			On completion this contains the plain body text.

@param aCharsetOverride 	The new charset with which to override the existing charset 

							when data is stored a 8 bit plain text format. 

@return void.

*/

void CMsvStore::RestorePlainBodyTextL(CRichText& aRichText, TUint aCharsetOverride)

	{

	RMsvReadStream inputStream;

	TBool is8Bit = EFalse;

	TUint charSet = 0;

	TUint defaultCharSet = 0;

	if(IsPresentL(KMsvPlainBodyText8))

		{

		inputStream.OpenLC(*this, KMsvPlainBodyText8);

		charSet = inputStream.ReadUint32L();

		defaultCharSet = inputStream.ReadUint32L();

		is8Bit = ETrue;

		}

	else

		{

		inputStream.OpenLC(*this, KMsvPlainBodyText16);

		}

	// If a new charset was set, override the  restored charset so that 

	// data is converted using new charset.

	if(aCharsetOverride!=0)

		{

		charSet = aCharsetOverride;

		}

	TBool committed = inputStream.ReadUint32L();

	TFileName filePath;

	HBufC* fileName = HBufC::NewLC(inputStream, KMaxFileName);	

	RFile bodyTextFile;

	CleanupClosePushL(bodyTextFile);

	iStoreManager.BodyTextFilePathL(iId, filePath);

	filePath.Append(*fileName);

	iStoreManager.OpenBodyTextFileForReadL(bodyTextFile, iId, filePath);

	if(is8Bit)

		{

		GetRichTextFrom8BitL(bodyTextFile, aRichText, charSet, defaultCharSet);

		}

	else

		{

		GetRichTextFrom16BitL(bodyTextFile, aRichText);

		}

	CleanupStack::PopAndDestroy(3, &inputStream);//bodyTextFile,fileName,in

	}

/**	

Restores 8 bit body text from the Message Store

@param aInputStream		on completion the RFileReadStream contains the message body text stream.

*/

void CMsvStore::Restore8BitBodyTextL(RFileReadStream& aInputStream)

	{

	RMsvReadStream in;

	in.OpenLC(*this, KMsvPlainBodyText8);

	in.ReadUint32L();	// reads charset

	in.ReadUint32L();	// read default charset

	in.ReadUint32L();	// returns ETrue if committed to message store else EFalse

	TFileName filePath;

	HBufC* fileName = HBufC::NewLC(in, KMaxFileName);

	RFile bodyTextFile;

	CleanupClosePushL(bodyTextFile);

	iStoreManager.BodyTextFilePathL(iId, filePath);

	filePath.Append(*fileName);

	iStoreManager.OpenBodyTextFileForReadL(bodyTextFile, iId, filePath);

	aInputStream.Attach(bodyTextFile, 0);

	CleanupStack::PopAndDestroy(3, &in);	// bodyTextFile, fileName, in

	}	

/**

Gets CRichText from plain body text file if data stored as 8 bit.

@param aFile 			The file containing the plain body text.

@param aRichText 		The CRichText object that will be filled on return.

@param aCharSet 		The charset of the body part.

@param aDefaultCharSet  The default charset of the system.

@return void.

*/	

void CMsvStore::GetRichTextFrom8BitL(RFile& aBodyTextFile, CRichText& aRichText, TUint aCharSet, TUint aDefaultCharSet)

	{

	Convert8BitToRichTextL(aBodyTextFile, aRichText, aCharSet, aDefaultCharSet);

	}

/**

Gets CRichText from plain body text file if data stored as 16 bit.

@param aFile 	  The file containing the plain body text.

@param aRichText  The CRichText object that will be filled on return.

@return void.

*/

void CMsvStore::GetRichTextFrom16BitL(RFile& aBodyTextFile, CRichText& aRichText)

	{

	TInt size = 0;

	aBodyTextFile.Size(size);

	TBuf8<KMsvDecodeChunkLength> buf;

	TBool carriageReturn = EFalse;

	while(size > 0)

		{

		aBodyTextFile.Read(buf);

		// Divide by 2 since the 16-bit buffer was stored using 8-bit pointer.

		TPtrC16 bodyTextPtr((TUint16*)(buf.Ptr()), buf.Length()/2); 

		// Was the last character of the last block a carriage return.

		// If so we need to check for the specific condition where the carriage

		// return / line feed has been split across blocks in which case the line

		// feed should be discarded and the special character ELineBreak inserted

		// instead. If the first character of this new block is not line feed

		// then we should insert the carriage return as it is required in the

		// output data and has not been added yet.

		if (carriageReturn)

			{

			if (bodyTextPtr[0] == KLineFeed)

				{

				aRichText.InsertL(aRichText.DocumentLength(), CEditableText::ELineBreak);

				bodyTextPtr.Set(bodyTextPtr.Mid(1));

				}

			else

				{

				aRichText.InsertL(aRichText.DocumentLength(), TChar(KCarriageReturn));

				}

			carriageReturn = EFalse;

			}

		TInt start = 0;

		TInt len = bodyTextPtr.Length();

		TInt i = 0;

		// Insert the data read from the RFile to CRichText.If there is CRLF insert 

		// CEditableText::ELineBreak  

		for(i=1; i<len; ++i)

			{

			// This will get data from RFile line by line and insert it to CRichText.

			if(bodyTextPtr[i-1] == KCarriageReturn && bodyTextPtr[i] == KLineFeed)

				{

				TPtrC ptr = bodyTextPtr.Mid(start, (i-1)-start);

				aRichText.InsertL(aRichText.DocumentLength(), ptr);

				aRichText.InsertL(aRichText.DocumentLength(), CEditableText::ELineBreak);

				start = i+1;

				}

			}

		// We have inserted a line to the CRichText object, there were some more data left in

		// bodyTextPtr, so insert rest of it to CRichText.

		if (start != i)

			{

			// If last character is KCarriageReturn.

			if(bodyTextPtr[len - 1] == KCarriageReturn)

				{

				carriageReturn = ETrue;

				TPtrC ptr1 = bodyTextPtr.Mid(start, (i-1)-start);

		    	aRichText.InsertL(aRichText.DocumentLength(), ptr1);

				}

			else

				{

				TPtrC ptr2 = bodyTextPtr.Mid(start, i-start);

		    	aRichText.InsertL(aRichText.DocumentLength(), ptr2);

				}

			}

		size -= buf.Length();

		}

	// If the last character of the text was a carriage return, then we won't

	// have added it because we were waiting to check what the start of the next

	// block was. As there are no more blocks, the carriage return needs to be 

	// added now.

	if (carriageReturn)

		{

		aRichText.InsertL(aRichText.DocumentLength(), TChar(KCarriageReturn));

		}

	}

/**

Converts 8 bit data to Unicode and inserts to the CRichText object.

@param aFile 			The file containing the plain body text.

@param aRichText 		The CRichText object that will be filled on return.

@param aCharSet 		The charset of the body part.

@param aDefaultCharSet  The default charset of the system.

@return void.

*/

void CMsvStore::Convert8BitToRichTextL(RFile& aBodyTextFile, CRichText& aRichText, TUint aCharSet, TUint aDefaultCharSet)

	{

	RFileReadStream inputStream(aBodyTextFile);

	inputStream.PushL();

	MStreamBuf* sourceStream = inputStream.Source();

	CCnvCharacterSetConverter* converter = CCnvCharacterSetConverter::NewL();

	CleanupStack::PushL(converter);

	CCnvCharacterSetConverter::TAvailability available = CCnvCharacterSetConverter::ENotAvailable;

	if (aCharSet != 0)

		{

		available = converter->PrepareToConvertToOrFromL(aCharSet, iFs);

		} 

	if (available == CCnvCharacterSetConverter::ENotAvailable)

		{

		available = converter->PrepareToConvertToOrFromL(aDefaultCharSet, iFs);

		}

	if (available != CCnvCharacterSetConverter::EAvailable)

		{

		User::Leave(KErrNotSupported);

		}	

	HBufC8* inBuf = HBufC8::NewLC(KMsvDecodeChunkLength);

	HBufC16* outBuf = HBufC16::NewLC(KMsvDecodeChunkLength);

	TPtr8 inPtr = inBuf->Des();

	TPtr16 outPtr = outBuf->Des();

	// Used to preserve state across multiple calls to ConvertToUnicode.

	TInt state = CCnvCharacterSetConverter::KStateDefault; 

	TBool newLine = EFalse;

	TBool newPara = EFalse;

	TInt bytesRemaining = sourceStream->SizeL();

	while(bytesRemaining > 0)

		{

		// Set the buffer length to the smaller of the number of bytes remaining,

		// or the chunk length.

		inPtr.SetLength(bytesRemaining < KMsvDecodeChunkLength ? bytesRemaining : KMsvDecodeChunkLength);

		// Read data from stream up to and including the 1st LF encountered.

		TRAPD(err, inputStream.ReadL(inPtr,TChar(KLineFeed)));

		if (err != KErrEof)

			{

			User::LeaveIfError(err);

			}

		TInt inBufLength = inPtr.Length();

		__ASSERT_DEBUG(inBufLength > 0, PanicServer(EMsvInputBufferEmpty));

		bytesRemaining -= inBufLength;

		// If the data read is terminated with an LF or CRLF, remove it and mark it for

		// appending a rich text line end or paragraph delimiter. 

		TInt bytesTruncated = 0;

		if (inPtr[inBufLength - 1] != KLineFeed)

			{

			// The data read does not contain any new line or paragraph delimters.

			newLine = EFalse;

			newPara = EFalse;

			}

		else

			{

			// Data read is terminated with LF.  Truncate length of data to ignore LF or CRLF bytes.

			if (inBufLength > 1 && inPtr[inBufLength - 2] == KCarriageReturn)

				{

				bytesTruncated = 2;

				inBufLength -= bytesTruncated;

				inPtr.SetLength(inBufLength);  // Remove CRLF.

				}

			else

				{

				bytesTruncated = 1;

				inBufLength -= bytesTruncated;

				inPtr.SetLength(inBufLength);  // Remove LF.

				}

			// Work out if it should be a new line or new paragraph.

			if (inBufLength == 0)

				{

				if (newLine)

					{

					// There are more than two new line delimiters in a row with no data

					// between them - new paragraph.

					newLine = EFalse;

					newPara = ETrue;

					}

				else

					{

					newLine = ETrue;

					newPara = EFalse;

					}

				}

			else

				{

				// It's a new line.

				newLine = ETrue;

				newPara = EFalse;

				}

			}

		// Convert the 8 bit data to unicode.

		TInt bytesUnconverted = converter->ConvertToUnicode(outPtr, inPtr, state);

		User::LeaveIfError(bytesUnconverted);

		if (bytesUnconverted > 0)

			{

			// Some bytes could not be converted because the output buffer was too small.

			// Seek back to the position of the 1st unconverted byte and recalculate the bytes remaining.  

			TInt bytesSeekBack = bytesUnconverted + bytesTruncated;

			sourceStream->SeekL(MStreamBuf::ERead, EStreamMark, -bytesSeekBack);

			bytesRemaining += bytesSeekBack;

			newLine = EFalse;

			newPara = EFalse;

			}

		// There is no AppendL method for CRichText.  Insert decoded text at end of document instead.

		aRichText.InsertL(aRichText.DocumentLength(), outPtr);

		// Insert a new line or paragraph delimiter if necessary.

		if (newLine)

			{

			aRichText.InsertL(aRichText.DocumentLength(), CEditableText::ELineBreak);

			}

		if (newPara)

			{

			aRichText.InsertL(aRichText.DocumentLength(), CEditableText::EParagraphDelimiter);

			}

		}

	CleanupStack::PopAndDestroy(4, &inputStream); //outBuf,inBuf,converter,inputStream

	}

EXPORT_C void CMsvStore::DeleteBodyTextL()

//

// Deletes the body text stream

//

/** Deletes the stream that contains the body text. Write access is needed for 

this function.