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

// Implements the classes TSAREntry and CSmsSARStore

// 

//

/**

 @file

*/

#include <e32svr.h>

#include "gsmustor.h"

#include "Gsmumain.h"

const TDriveNumber KStoreDrive = EDriveC;

_LIT(KStoreSubDir, "sms\\");

/**

 *  Utility func for cleanup stack - close the filestore and set pointer to NULL

 */

void CSARStoreCloseObject(TAny* aObj)

    {

    LOGGSMU2("WARNING! Hey, CSARStoreCloseObject called by Untrapper! [0x%08x]", aObj);

    ((CSARStore*)aObj)->Revert();

    }

//

// implementation of TSAREntry

//

/**

 *  Constructor

 *  

 *  @capability None

 */

EXPORT_C TSAREntry::TSAREntry():

	iReference(0),

	iTotal(0),

	iCount(0),

	iData1(0),

	iData2(0),

	iData3(0),

	iData4(0),

	iDataStreamId(KNullStreamId),

	iFlags(0)

	{

	} // TSAREntry::TSAREntry

/**

 *  Internalises the object.

 *  

 *  @param aStream Stream to read from

 *  @capability None

 */

EXPORT_C void TSAREntry::InternalizeL(RReadStream& aStream)

	{

	iReference=aStream.ReadInt32L();

	iTotal=aStream.ReadInt32L();

	iCount=aStream.ReadInt32L();

	iData1=aStream.ReadInt32L();

	iData2=aStream.ReadInt32L();

	iData3=aStream.ReadInt32L();

	iData4=aStream.ReadInt32L();

	aStream >> iDescription1;

	aStream >> iDescription2;

	TInt64 time;

	aStream >> time;

	iTime=time;

	aStream >> iDataStreamId;

	} // TSAREntry::InternalizeL

/**

 *  Externalises the object.

 *  

 *  @param aStream Stream to write to

 *  @capability None

 */

EXPORT_C void TSAREntry::ExternalizeL(RWriteStream& aStream) const

	{

	aStream.WriteInt32L(iReference);

	aStream.WriteInt32L(iTotal);

	aStream.WriteInt32L(iCount);

	aStream.WriteInt32L(iData1);

	aStream.WriteInt32L(iData2);

	aStream.WriteInt32L(iData3);

	aStream.WriteInt32L(iData4);

	aStream << iDescription1;

	aStream << iDescription2;

	aStream << Time().Int64();

	aStream << iDataStreamId;

	} // TSAREntry::ExternalizeL

//

// implementation of CSARStore

//

/**

 *  Opens a specified SAR store.

 *  

 *  A SAR filestore has has three uids, KPermanentFileStoreLayoutUid, KSARStoreUid

 *  (which designates that the file store is a SAR store) and a third UID, that

 *  identifies the particular implementation of CSARStore.

 *  

 *  @param aFullName Name for the segmentation and reassembly filestore

 *  @param aThirdUid Third UID for the filestore.

 *  @capability None

 */

EXPORT_C void CSARStore::OpenL(const TDesC& aFullName, const TUid& aThirdUid)

	{

#ifdef _SMS_LOGGING_ENABLED

	TBuf8<80> buf8;

	buf8.Copy(aFullName);

	LOGGSMU2("CSARStore::OpenL(): '%S'", &buf8);

#endif

	// sanity check

	__ASSERT_DEBUG(iFileStore==NULL,Panic(KGsmuPanicSARStoreAlreadyOpen));

	__ASSERT_DEBUG(!iInTransaction, Panic(KGsmuPanicSARStoreTransaction));

	__ASSERT_DEBUG(iEntryArray.Count()==0,Panic(KGsmuPanicSARStoreEntryArrayNotReset));

	iFullName.Set(aFullName);

	iThirdUid = aThirdUid;

	// first opening we have to Internalize

	DoOpenL();

 	// defect fix for EDNJJUN-4WYJGP

 	// Unable to send sms cause sms*.dat is corrupted

 	// TODO - has to be back ported to higher versions

 	TRAPD(ret, InternalizeEntryArrayL());

	if (ret != KErrNone)

		{

		LOGGSMU2("WARNING: InteralizeEntryArrayL left with %d", ret);

		}

 	if(ret == KErrCorrupt || ret == KErrEof || ret == KErrNotFound)

	 	{

 		Close();             //because the file is in use

		User::LeaveIfError(iFs.Delete(iFullName));

		DoOpenL();

 		}

	else

		User::LeaveIfError(ret);

	} // CSARStore::OpenL

/**

 *  Commits a transaction to the filestore.

 *  @capability None

 */

EXPORT_C void CSARStore::CommitTransactionL()

// This function does the real work of updating the filestore

	{

    LOGGSMU4("CSARStore::CommitTransactionL(): this=0x%08X iInTransaction=%d iFileStore=0x%08X",

    		 this, iInTransaction, iFileStore);

	__ASSERT_DEBUG(iFileStore!=NULL, Panic(KGsmuPanicSARStoreNotOpen));

	__ASSERT_DEBUG(iInTransaction, Panic(KGsmuPanicSARStoreTransaction));

#ifdef _SMS_LOGGING_ENABLED

	TRAPD(err, DoCommitAndCompactL());

	if (err != KErrNone)

		{

		LOGGSMU2("WARNING! could not CommitL/CompactL due to %d", err);

		User::Leave(err);

		}

#else

	DoCommitAndCompactL();

#endif

	//TODO AA: What should we do if err == KErrCorrupt?

	CleanupStack::Pop(this);

	iInTransaction = EFalse;

	RemoveDeletedEntries();

	} // CSARStore::CommitTransactionL

/**

 *  Closes the file store.

 *  

 *  The function deletes the file store object and resets the entry array. It

 *  should be called once when the protocol module is closing down.

 *  @capability None

 */

EXPORT_C void CSARStore::Close()

	{

#ifdef _SMS_LOGGING_ENABLED

	TBuf8<80> buf8;

	buf8.Copy(iFullName);

	LOGGSMU2("CSARStore::Close(): '%S'", &buf8);

#endif

	__ASSERT_DEBUG(!iInTransaction, Panic(KGsmuPanicSARStoreTransaction));

	delete iFileStore;

	iFileStore=NULL;

	iEntryArray.Reset();

	} // CSARStore::Close

/**

 *  Gets a const reference to the entry array.

 *  

 *  @return Entry array

 *  @capability None

 */

EXPORT_C const CArrayFix<TSAREntry>& CSARStore::Entries() const

	{

	return iEntryArray;

	} // CSARStore::Entries

/**

 *  Purges the reassembly file store.

 *  

 *  After a multipart message, it delete all the old entries.

 *  

 *  Entries will be purged when: 1) The complete message is received; 2) After

 *  aTimerintervalMinutes, if aPurgeIncompletely is false.

 *  

 *  PurgeL() will be called after the booting of the device or when a message

 *  has been received.

 *  

 *  This function opens and closes the file automatically.

 *  

 *  Note: overload function for segmentation store.

 *  

 *  @param aTimeIntervalMinutes Purge time

 *  @param aPurgeIncompleteOnly Purge complete messages flag

 *  @capability None

 */

EXPORT_C void CSARStore::PurgeL(const TTimeIntervalMinutes& aTimeIntervalMinutes,

								TBool aPurgeIncompleteOnly)

//

// TODO ahe - performance filestore / sms

// In many cases the files will be opened and closed but no entry will be deleted.

// Conclusion:

// 1) only open, close, externalize and compact the file when an entry

//    really shall be deleted

// 2) Compact the file after purging, only compact it here

// 3) Only purge the segmentation store if the send queue is empty

//    and only purge the reassembly store when the receiv queue is full

//

// TODO ahe - for last release -

// message can be lost during crash: this issue has to be redesigned but

// after the reboot of the device the information in the stores could be lost

// due to purging or compacting - a single pdu always gets lost due to not

// storing it in the reassembly store.

//

	{

	LOGGSMU3("CSARStore::PurgeL(): aTimeIntervalMinutes=%d, aPurgeIncompleteOnly=%d",

			 aTimeIntervalMinutes.Int(), aPurgeIncompleteOnly);

	// TODO - flag

	// we could also save the call of the method from the consruction of the smsprot

	if( aPurgeIncompleteOnly )

		return;

	TInt count=iEntryArray.Count();

	LOGGSMU2("CSARStore::PurgeL(): count=%d", count);

	TTime time;

	time.UniversalTime();

	// we open the file outside the loop

	// to save some CPU

	BeginTransactionLC();

	for (TInt i=count-1; i>=0; i--)

		{

		TSAREntry entry=iEntryArray[i];

		if (((time>(entry.Time()+aTimeIntervalMinutes)) && !aPurgeIncompleteOnly ))

			// TODO - flag

			// check the logic o the aPurgeIncompleteOnly flg

			// don't purge the store if the entry is complete

			// entry.IsComplete()  )

			{

			DoDeleteEntryL(i);

			}

		}

	ExternalizeEntryArrayL();

	CommitTransactionL();

	} // CSARStore::PurgeL

/**

 *  Purges the segmentation store.

 *  

 *  This purges the filestore after a multipart message, deleting all the old

 *  entries.

 *  

 *  This function opens and closes the file automatically.

 *  

 *  @param aKSegmentationLifetimeMultiplier The coefficient for calculating whether

 *  a message should be purged

 *  @param aPurgeIncompleteOnly Set to false to purge all entries. Set to true

 *  to purge incomplete messages only.

 *  @capability None

 */

EXPORT_C void CSARStore::PurgeL(TInt aKSegmentationLifetimeMultiplier,TBool aPurgeIncompleteOnly)

	{

	LOGGSMU3("CSARStore::PurgeL(): aKSegmentationLifetimeMultiplier=%d, aPurgeIncompleteOnly=%d",

			 aKSegmentationLifetimeMultiplier, aPurgeIncompleteOnly);

	TInt count=Entries().Count();

	LOGGSMU2("CSARStore::PurgeL(): count=%d", count);

	TTime time;

	time.UniversalTime();

	// we open the file outside the loop

	// to save some CPU

	BeginTransactionLC();

	TInt numDeletedEntry = 0;

	for (TInt i=count-1; i>=0; i--)

		{

		const TSmsSegmentationEntry& entry = (const TSmsSegmentationEntry&)Entries()[i];

		const TTimeIntervalMinutes lifetime((entry.ValidityPeriod()*aKSegmentationLifetimeMultiplier)/1000);

		//

		// AEH: Defect fix for EDNPAHN-4WADW3 'Unreliable logging'

		//

		//      This should solve the problem with agressive PurgeL algorithm

		//      deleting PDUs which are waiting for Status Reports.

		//      Extra bit in TSAREntry indicating Status Reports.

		//      if we don't expect a status report, fake the

		//      number of delivered and failed to be equal

		//      to Total.

		//

		const TBool have_sr = entry.ExpectStatusReport();

		const TInt deliv_n_failed = have_sr

		  ? entry.Delivered() + entry.Failed() // total acked PDUs

		  : entry.Total();                     // fake

		if (

			(entry.IsComplete() && (deliv_n_failed >= entry.Total()))

			||

			((time>(entry.Time()+lifetime)) && !aPurgeIncompleteOnly )

			)

			{

			DoDeleteEntryL(i);

			++numDeletedEntry;

			}

		}

	TInt numOldestEntry = 0;

	if(iMaxmumNumberOfMessagesInSegmentationStore > 0)

		{

		while((count - numDeletedEntry) > iMaxmumNumberOfMessagesInSegmentationStore)

			{ // The number of messages in the store is greater than the allowed number. Find&Delete the oldest one.

			  // If the maximum number of messages is set to o, we don't delete any messages.

			while (Entries()[numOldestEntry].IsDeleted())

				{ // Find oldest entry that has not been deleted already

				++numOldestEntry;

				}

			DoDeleteEntryL(numOldestEntry++);

			++numDeletedEntry;

			}

		}

	ExternalizeEntryArrayL();

	CommitTransactionL();

	LOGGSMU1("CSmsSegmentationStore::PurgeL End");

	} // CSARStore::PurgeL

/**

 *  Deletes an entry from the entry array, and externalizes it.

 *  

 *  The file store must be open before calling this function.

 *  

 *  @param aIndex Entry in the SAR store to delete

 *  @capability None

 */

EXPORT_C void CSARStore::DeleteEntryL(TInt aIndex)

	{

	LOGGSMU2("CSARStore::DeleteEntryL(): aIndex=%d", aIndex);

	DoDeleteEntryL(aIndex);

	ExternalizeEntryArrayL();

	} // CSARStore::DeleteEntryL

/**

 *  Constructor, initialises class members only.

 *  

 *  @param aFs File system handle

 *  @capability None

 */

EXPORT_C CSARStore::CSARStore(RFs& aFs)

    :iFs(aFs)

    ,iEntryArray(8)

    {

    } // CSARStore::CSARStore

/**

 *  Destructor. Frees resource.

 *  @capability None

 */

EXPORT_C CSARStore::~CSARStore()

    {

	delete iFileStore;

    } // CSARStore::CSARStore

/**

 *  Gets a reference to the filestore.

 *  

 *  @return The filestore

 *  @capability None

 */

EXPORT_C CFileStore& CSARStore::FileStore()

	{

	LOGGSMU1("CSARStore::FileStore()");

	__ASSERT_DEBUG(iFileStore!=NULL,Panic(KGsmuPanicSARStoreNotOpen));

	return *iFileStore;

	} // CSARStore::FileStore

/**

 *  Gets a (const) reference to the filestore.

 *  

 *  @return The filestore

 *  @capability None

 */

EXPORT_C const CFileStore& CSARStore::FileStore() const

    {

    // Ignore in code coverage - not used in SMS stack.

    BULLSEYE_OFF

    LOGGSMU1("CSARStore::FileStore()");

    __ASSERT_DEBUG(iFileStore!=NULL,Panic(KGsmuPanicSARStoreNotOpen));

    return *iFileStore;

    BULLSEYE_RESTORE

    }

/**

 *  Adds a new entry to the file store.

 *  

 *  The function appends the new entry to the internal entry array, and then externalises

 *  it.

 *  

 *  The file store must be open before calling this function.

 *  

 *  @param aEntry SAR entry to add

 *  @capability None

 */

EXPORT_C void CSARStore::AddEntryL(const TSAREntry& aEntry)

	{

	LOGGSMU1("CSARStore::AddEntryL()");

	__ASSERT_DEBUG(iFileStore!=NULL,Panic(KGsmuPanicSARStoreNotOpen));

	__ASSERT_DEBUG(aEntry.DataStreamId()!=KNullStreamId,Panic(KGsmuPanicSAREntryDataStreamIdNotSet));

	iEntryArray.AppendL(aEntry);

	iEntryArray[iEntryArray.Count()-1].SetIsAdded(ETrue);

	ExternalizeEntryArrayL();

	} // CSARStore::AddEntryL

/**

 *  Changes an entry in the file store - changes it first in the internal

 *  entry array, and then externalizes it.

 *  

 *  The file store must be open before calling this function.

 *  

 *  @param aIndex The index into the SAR store to be changed

 *  @param aNewEntry The new SAR store entry

 *  @capability None

 */

EXPORT_C void CSARStore::ChangeEntryL(TInt aIndex,const TSAREntry& aNewEntry)

	{

	LOGGSMU2("CSARStore::ChangeEntryL(): aIndex=%d", aIndex);

	__ASSERT_DEBUG(iFileStore!=NULL,Panic(KGsmuPanicSARStoreNotOpen));

	__ASSERT_DEBUG(iEntryArray[aIndex].DataStreamId()==aNewEntry.DataStreamId(),Panic(KGsmuPanicSAREntryDataStreamIdChanged));

	iEntryArray[aIndex].SetIsDeleted(ETrue);

	iEntryArray.InsertL(aIndex,aNewEntry);

	iEntryArray[aIndex].SetIsAdded(ETrue);

	ExternalizeEntryArrayL();

	} // CSARStore::ChangeEntryL

/**

 *  Gets the extra stream ID.

 *  

 *  @return Extra stream ID

 *  @capability None

 */

EXPORT_C TStreamId CSARStore::ExtraStreamId() const

	{

	LOGGSMU1("CSARStore::ExtraStreamId");

	return iExtraStreamId;

	} // CSARStore::ExtraStreamId

/**

 *  Sets the extra stream ID - changes it first in the internal

 *  entry array, and then externalizes it.

 *  

 *  You must call Close() when the function returns.

 *  

 *  @param aExtraStreamId Extra stream ID

 *  @capability None

 */

EXPORT_C void CSARStore::SetExtraStreamIdL(const TStreamId& aExtraStreamId)

	{

	LOGGSMU2("CSARStore::SetExtraStreamIdL(): id=%d", aExtraStreamId.Value());