/*

* Copyright (c) 2006-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:  

*       SMS Details Ecom Plugin implementation.

*

*/

// INCLUDE FILES

#include <e32std.h>

#include <implementationproxy.h>

#include <data_caging_path_literals.hrh> 

#include <gsmumsg.h>

#include <gsmuieoperations.h>

#include <gsmubuf.h>

#include <txtetext.h>   // CEditableText

#include <MVPbkContactStore.h>

#include <MVPbkContactStoreProperties.h>

#include <contactmatcher.h>

#include <CVPbkContactStoreUriArray.h>

#include <MVPbkContactLink.h>

#include <CVPbkContactLinkArray.h>

#include <MVPbkFieldType.h>

#include <TVPbkFieldVersitProperty.h>

#include <MVPbkStoreContact.h>

#include <CVPbkPhoneNumberMatchStrategy.h>

#include <VPbkContactStoreUris.h>

#include <TVPbkContactStoreUriPtr.h>

#include <CPbk2StoreConfiguration.h>   // Contact store configuration

#include <StringLoader.h>               // StringLoader

#include <stringresourcereader.h>

#include <centralrepository.h>

#include <telconfigcrkeys.h>    // KCRUidTelephonyConfiguration

#include <commonphoneparser.h>      // Common phone number validity checker

#include <smsdetailsplugindata.rsg>

#include "smsdetailsplugin.h"

//For logging

#include "SmumLogging.h"

// CONSTANTS

const TInt KSmsDefaultGsmNumberMatchLength = 7;

const TInt KErrMultipleMatchFound = KErrGeneral;

_LIT( KSmsDetailsPluginResourceFile, "smsdetailsplugindata.rsc" );

struct TCntMatchRequestData

    {

    TPtrC iFromAddress;

    TDes* iOutput;

    TInt iMaxLength;

    TInt iMatchDigitCount;

    };

class CSmsDetailsPluginOneShotOperation : public CActive

    {

public:

    CSmsDetailsPluginOneShotOperation( TCntMatchRequestData& aRequestData );

    ~CSmsDetailsPluginOneShotOperation();

public: // API

    inline TInt CompletionCode() const { return iStatus.Int(); }

private: // From CActive

    void RunL();

    void DoCancel();

private: // Internal functions

    void MatchContactL();

    HBufC* GetContactNameL(const MVPbkContactLink& aContactLink);

    HBufC* GetContactNameInLowerCaseL(const MVPbkContactLink& aContactLink );

    TBool  ShowContactNameL(CVPbkContactLinkArray* aLinkArray, TInt &nameIndex);

    TInt GetCurrentStoreIndexL( CVPbkContactLinkArray& aLinkArray );

private: // Data members

    TCntMatchRequestData& iRequestData;

    CContactMatcher* iContactMatcher;

    };

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

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

// Define the implementation table for Ecom

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

//

const TImplementationProxy ImplementationTable[] = 

	{

	IMPLEMENTATION_PROXY_ENTRY(0x102828A8, CSmsDetailsPlugin::NewL)

	};

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

// Returns the implementation table

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

//

EXPORT_C const TImplementationProxy* ImplementationGroupProxy(TInt& aTableCount)

	{

	aTableCount = sizeof(ImplementationTable) / sizeof(TImplementationProxy);

	return ImplementationTable;

	}

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

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

// CSmsDetailsPlugin::NewL

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

//

CSmsDetailsPlugin* CSmsDetailsPlugin::NewL()

	{

	SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::NewL");

	CSmsDetailsPlugin* self = new (ELeave) CSmsDetailsPlugin();	

	SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::NewL");

	return self;

	}

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

// CSmsDetailsPlugin::CreateResourceReaderL

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

//

void CSmsDetailsPlugin::CreateResourceReaderL( RFs* aFs )

	{

	SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::CreateResourceReaderL");

	if ( !iResourceReader )

	    {

        TParse fileParse;

        fileParse.Set( KSmsDetailsPluginResourceFile, &KDC_RESOURCE_FILES_DIR, NULL );

        TFileName resourceFile( fileParse.FullName() );

        if ( aFs )

            {

            iResourceReader = CStringResourceReader::NewL( resourceFile, *aFs );

            }

        else

            {

            iResourceReader = CStringResourceReader::NewL( resourceFile );

            }

	    }

	SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::CreateResourceReaderL");

	}

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

// CSmsDetailsPlugin::CSmsDetailsPlugin

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

//

CSmsDetailsPlugin::CSmsDetailsPlugin()

	{

	}

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

// CSmsDetailsPlugin::~CSmsDetailsPlugin

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

//

CSmsDetailsPlugin::~CSmsDetailsPlugin()

	{

	SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::~CSmsDetailsPlugin");

	delete iResourceReader;

    SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::~CSmsDetailsPlugin");

	}

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

// CSmsDetailsPlugin::GetDetails

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

//

TInt CSmsDetailsPlugin::GetDetails(RFs& aFs, const CSmsMessage& aMessage, TDes& aDetails, TInt aMaxLength)

	{

    SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::GetDetails(aFs, aMessage, aDetails, aMaxLength");

	__ASSERT_DEBUG( aMaxLength <= aDetails.MaxLength(), User::Invariant() );

	if (aMaxLength > aDetails.MaxLength())

		{

		aMaxLength = aDetails.MaxLength();

		}

	aDetails.Zero();

	TPtrC fromAddress;

	switch (aMessage.SmsPDU().Type())

		{

		case CSmsPDU::ESmsSubmit:

		case CSmsPDU::ESmsDeliver:

		case CSmsPDU::ESmsStatusReport:

			fromAddress.Set(aMessage.SmsPDU().ToFromAddress());

			break;

		default:

			return KErrNotSupported;

		}

	SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::GetDetails(aFs, aMessage, aDetails, aMaxLength");

	return GetDetails(aFs, fromAddress, aDetails, aMaxLength);

	}

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

// CSmsDetailsPlugin::GetDetails

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

//

TInt CSmsDetailsPlugin::GetDetails(RFs& aFs, const TDesC& aFromAddress, TDes& aDetails, TInt aMaxLength)

	{

    SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::GetDetails(aFs, aFromAddress, aDetails, aMaxLength");

	__ASSERT_DEBUG( aMaxLength <= aDetails.MaxLength(), User::Invariant() );

	if (aMaxLength > aDetails.MaxLength())

		{

		aMaxLength = aDetails.MaxLength();

		}

    TInt ret = KErrNone;

	TRAPD(err, DoGetDetailsL(aFs, aFromAddress, aDetails, aMaxLength));

	if ( (err != KErrNone) || (aDetails.Length() == 0) )

		{

		if (aFromAddress.Length() <= aMaxLength)

			{

			aDetails = aFromAddress;

			aDetails.Trim();

			}

		else

			{

			// Truncate aFromAddress so that it fits into aDetails.

			aDetails = aFromAddress.Left(aMaxLength);

			aDetails.Trim();

			}

        // Propagate KErrCancel forwards

        if ( err == KErrCancel )

            {

            ret = err;

            }

		}

    SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::GetDetails(aFs, aFromAddress, aDetails, aMaxLength");

	return ret;

	}

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

// CSmsDetailsPlugin::GetDescription

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

//

TInt CSmsDetailsPlugin::GetDescription(const CSmsMessage& aMessage, TDes& aDescription, TInt aMaxLength)

	{

    SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::GetDescription(aMessage, aDescription, aMaxLength");

	__ASSERT_DEBUG( aMaxLength <= aDescription.MaxLength(), User::Invariant() );

	if (aMaxLength > aDescription.MaxLength())

		{

		aMaxLength = aDescription.MaxLength();

		}

	aDescription.Zero();

	TBool gotDescription = EFalse;

	TRAPD(err, gotDescription = DoGetDescriptionL(aMessage, aDescription, aMaxLength));

	if(err != KErrNone || !gotDescription)

	    {

		ExtractDescriptionFromMessage(aMessage, aDescription, aMaxLength);

	    }

    SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::GetDescription(aMessage, aDescription, aMaxLength");

	return KErrNone;

	}

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

// CSmsDetailsPlugin::DoGetDetailsL

//

// For clarity the whole function is flagged

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

//

void CSmsDetailsPlugin::DoGetDetailsL(RFs& aFs, const TDesC& aFromAddress, TDes& aDetails, TInt aMaxLength)

	{

	__UHEAP_MARK;

    SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::DoGetDetailsL(aFs, aFromAddress, aDetails, aMaxLength");

	// Check that aFromAddress is a valid GSM telephone number

    if ( !CommonPhoneParser::IsValidPhoneNumber( aFromAddress, CommonPhoneParser::ESMSNumber ) )

        {

		User::Leave( KErrArgument );

        }

	aDetails.Zero();

    TInt matchDigitCount = KSmsDefaultGsmNumberMatchLength;

    // Read the amount of digits to be used in contact matching

    // The key is owned by PhoneApp

    CRepository* repository = CRepository::NewLC(KCRUidTelConfiguration);

    if (KErrNone == repository->Get(KTelMatchDigits, matchDigitCount))

        {

        // Min is 7

        matchDigitCount =

            Max(matchDigitCount, KSmsDefaultGsmNumberMatchLength);

        }

    CleanupStack::PopAndDestroy(); // repository

    // Match contacts to the from address

    // Prepare worker thread arguments

    TCntMatchRequestData requestData;

    requestData.iFromAddress.Set( aFromAddress );

    requestData.iOutput = &aDetails;

    requestData.iMaxLength = aMaxLength;

    requestData.iMatchDigitCount = matchDigitCount;

    // Prepare thread name

    _LIT( KSmsDetailsPluginCntMatcherWorkerThreadName, "S60SmsDetailsPluginWorkerThread_%08x" );

    TName threadName;

    threadName.AppendFormat( KSmsDetailsPluginCntMatcherWorkerThreadName, &requestData );

    // Create worker thread 

    RThread workerThread;

    CleanupClosePushL( workerThread );

    /*

     * LSAN-7HUB6B:: Contact matcher thread was using watcher process stack and hence running

     * out of memory as the inbox was growing. At some point, when inbox has arnd 1700 msgs, it fails to allocate memory

     * and hence there was no matching. 

     * changed the thread creation to use seperate stack of 1MB max size.

     */

    const TInt threadCreationError = workerThread.Create( threadName, CntMatchThreadFunction, 8 * 1024, 0x1000, 0x100000, &requestData  );

    User::LeaveIfError( threadCreationError );

    // Wait for thread to finish work

    TRequestStatus workerThreadStatus;

    workerThread.Rendezvous( workerThreadStatus );

    workerThread.Resume();

    User::WaitForRequest( workerThreadStatus );

    // Propagate error

    User::LeaveIfError( workerThreadStatus.Int() );

    // Tidy up

    CleanupStack::PopAndDestroy( &workerThread );

    SMUMLOGGER_LEAVEFN("CSmsDetailsPlugin::DoGetDetailsL(aFs, aFromAddress, aDetails, aMaxLength");

    __UHEAP_MARKEND;

    }

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

// CSmsDetailsPlugin::DoGetDescriptionL

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

//

TBool CSmsDetailsPlugin::DoGetDescriptionL(const CSmsMessage& aMessage,

    TDes& aDescription, TInt aMaxLength)

// this function returns EFalse if aMessage has no special message indication data and is not an SMS_STATUS_REPORT,

// i.e. more needs to be done to extract the description from the message

// otherwise returns ETrue

	{

    SMUMLOGGER_ENTERFN("CSmsDetailsPlugin::DoGetDescriptionL(aMessage, aDescription, aMaxLength");

    TInt resourceId = 0;

	TBuf<KSmsDescriptionLength> format;

	TSmsMessageIndicationType messageIndicationType;

	TExtendedSmsIndicationType extendedType;

	TSmsMessageProfileType messageProfileType;

	TBool toStore=EFalse;

	TUint totalIndicationCount=0;

	TUint totalMessageCount=0;	

	//check if the messae contains an enhanced voice mail indication

	CSmsEnhancedVoiceMailOperations& enhancedVoiceMailOperations = STATIC_CAST(CSmsEnhancedVoiceMailOperations&,aMessage.GetOperationsForIEL(CSmsInformationElement::ESmsEnhanceVoiceMailInformation));

	if(enhancedVoiceMailOperations.ContainsEnhancedVoiceMailIEL())

		{

		//get a copy of the indication

		CEnhancedVoiceMailBoxInformation* retrievedNotification=enhancedVoiceMailOperations.CopyEnhancedVoiceMailIEL();

		TVoiceMailInfoType typeInfo=retrievedNotification->Type();

		//check its type

		if(typeInfo==EGsmSmsVoiceMailNotification)

			{

			//increment the indication count

			++totalIndicationCount;

			resourceId = R_MSG_INDICATION_ENHANCED_VOICEMAIL_ONE;	

			}

		TUint8 messageCount=retrievedNotification->NumberOfVoiceMessages();

		//add the message count to the running total

		totalMessageCount+=messageCount;

		//if there is more that one message of this type then set the resouce id to 'many'

		if(messageCount!=1)

			{

			++resourceId;	

			}

		delete retrievedNotification;

		}  

	//check for special message waiting indications

	CSmsSpecialSMSMessageOperations& operations = STATIC_CAST(CSmsSpecialSMSMessageOperations&,aMessage.GetOperationsForIEL(CSmsInformationElement::ESmsIEISpecialSMSMessageIndication));

	TUint specialMessageIndicationCount=operations.GetCountOfSpecialMessageIndicationsL();	

	if(specialMessageIndicationCount!=0)

		{

		//add special message indications to out indication count

		totalIndicationCount+=specialMessageIndicationCount;	

		if(totalIndicationCount>1) 

			{

			//set the resource id to R_MSG_INDICATION_OTHER_ONE

			resourceId = R_MSG_INDICATION_OTHER_ONE;

			//get the total number of messages from the indicatations

			TUint8 messageCount=0;

			for(TInt loopCount=0;loopCount<specialMessageIndicationCount;loopCount++)

				{

				operations.GetMessageIndicationIEL(loopCount,toStore,messageIndicationType,extendedType,messageProfileType,messageCount);

				totalMessageCount+=messageCount;						

				}

			}

		else

			{

			//there is only one indication, get it's type and the number of messages it holds.

			TUint8 messageCount=0;

			operations.GetMessageIndicationIEL(0,toStore,messageIndicationType,

											extendedType,messageProfileType,messageCount);	

			//add the message count to the running total

			totalMessageCount+=messageCount;

			switch (messageIndicationType)

				{

				case EGsmSmsVoiceMessageWaiting:

					resourceId = R_MSG_INDICATION_VOICEMAIL_ONE;

					break;

				case EGsmSmsFaxMessageWaiting:

					resourceId = R_MSG_INDICATION_FAX_ONE;

					break;

				case EGsmSmsElectronicMailMessageWaiting:

					resourceId = R_MSG_INDICATION_EMAIL_ONE;

					break;

				case EGsmSmsExtendedMessageTypeWaiting:

					//get the extended indications type

					if(extendedType==EGsmSmsVideoMessageWaiting)

						{

						resourceId = R_MSG_INDICATION_VIDEOMESSAGE_ONE;	

						}

					else

						{

						resourceId = R_MSG_INDICATION_OTHER_ONE;	

						}

					break;

				default:

					resourceId = R_MSG_INDICATION_OTHER_ONE;

					break;

				}	

			}

		//if there is more that one message waiting append 'many' to the id.

		if(totalMessageCount!=1)

			{

			resourceId++;	

			}

		}

	const CSmsPDU& smsPDU= aMessage.SmsPDU();

	// If no Special Msg Indication found in the User Data,

	// then check the DataCodingScheme.

	if (totalIndicationCount==0 && smsPDU.DataCodingSchemePresent())

		{

		TInt bits7to4 = smsPDU.Bits7To4();

		switch (bits7to4)

			{

			case TSmsDataCodingScheme::ESmsDCSMessageWaitingIndication7Bit:

			case TSmsDataCodingScheme::ESmsDCSMessageWaitingIndicationUCS2:

				{

				if (smsPDU.IndicationState() == TSmsDataCodingScheme::ESmsIndicationActive)

					{

					totalIndicationCount = 1;

					switch (smsPDU.IndicationType())

						{

						case TSmsDataCodingScheme::ESmsVoicemailMessageWaiting:

							resourceId = R_MSG_INDICATION_VOICEMAIL_ONE;

							break;

						case TSmsDataCodingScheme::ESmsFaxMessageWaiting:

							resourceId = R_MSG_INDICATION_FAX_ONE;

							break;

						case TSmsDataCodingScheme::ESmsElectronicMailMessageWaiting:

							resourceId = R_MSG_INDICATION_EMAIL_ONE;

							break;

						case TSmsDataCodingScheme::ESmsFaxOtherMessageWaiting:

						default:

							resourceId = R_MSG_INDICATION_OTHER_ONE;

							break;

						} //end switch

					} //end if

				} //end case

			default:

				{

				break; //do nothing

				}

			}

		}

	if (totalIndicationCount!=0)

		{

		//Special message found.

		CreateResourceReaderL( NULL );

        format = iResourceReader->ReadResourceString( resourceId );

        if (totalMessageCount == 1)

            {

            if (format.Length() <= aMaxLength)

                {