// 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:

//

#include "Gsmumain.h"

#include "gsmuieoperations.h"

#include "Gsmumsg.h"

#include "gsmumsgadditionalattributes.h"

#include "Gsmuelem.h"

#include "smsstacklog.h"

/**

 *  This is used by the CSmsMessage to create a CSmsIEOperation.

 *  Each instance is owned by the CSmsMessage which created it.

 *  Therefore only the CSmsMessage (GSMU component) is allowed to

 *  create and delete CSmsIEOperations.

 *  

 *  @param aId

 *  The ID for the CSmsInformationElement for whom an operation class needs to be created.

 *  @param aMessage

 *  The CSmsMessage that this operations class belongs to.

 *  @param aCharacterSetConverter

 *  A reference to a character set converter, needed by some derived operation classes.

 *  @param aFs

 *  A reference to the file server, needed by some derived operations classes.

 *  

 *  @internalComponent

 */

CSmsIEOperation*  CSmsIEOperation::NewL(CSmsInformationElement::TSmsInformationElementIdentifier aId, CSmsMessage& aMessage, CCnvCharacterSetConverter& aCharacterSetConverter, RFs& aFs)

	{

	LOGGSMU1("CSmsIEOperation::NewL()");

	CSmsIEOperation* iEOperation = NULL;

	switch (aId)

	    {

	    case CSmsInformationElement::ESmsHyperLinkFormat:

	        iEOperation = new (ELeave)  CSmsHyperLinkOperations(aId,aMessage);

	        break;

	    case CSmsInformationElement::ESmsReplyAddressFormat:

	        iEOperation = new (ELeave) CSmsReplyAddressOperations(aId, aMessage, aCharacterSetConverter, aFs);

	        break;

	    case CSmsInformationElement::ESmsEnhanceVoiceMailInformation:

	        iEOperation = new (ELeave) CSmsEnhancedVoiceMailOperations(aId, aMessage, aCharacterSetConverter, aFs);

	        break;

	    case CSmsInformationElement::ESmsIEISpecialSMSMessageIndication:

	        iEOperation = new (ELeave)  CSmsSpecialSMSMessageOperations(aId,aMessage);

	        break;

	    case CSmsInformationElement::ESmsIEISMSCControlParameters:

	        iEOperation = new (ELeave)  CSmsSMSCCtrlParameterOperations(aId,aMessage); 

	        break;

	    default:

	        User::Leave(KErrArgument);

	        break;

	    }

	iEOperation->ConstructL();

	return iEOperation;

	} // CSmsIEOperation::NewL

/**

 *  @publishedAll

 *  

 *  Identifies the information element which is supported by this operations class.

 *  

 *  @return The information element ID supported by this operations class.

 *  @capability None

 */

EXPORT_C CSmsInformationElement::TSmsInformationElementIdentifier CSmsIEOperation::Id() const

	{

	LOGGSMU1("CSmsIEOperation::Id()");

	return iId;

	} // CSmsInformationElement::TSmsInformationElementIdentifier

/**

 *  @internalComponent

 *  

 *  Identifies whether the message type supports is supported

 *  

 *  @return True if the message type is supported. False otherwise.

 */

TBool CSmsIEOperation::MessageTypeSupported() const

	{

	LOGGSMU1("CSmsIEOperation::MessageTypeSupported()");

	CSmsPDU::TSmsPDUType type = iMessage.Type();

    return ((type == CSmsPDU::ESmsDeliver) ||

            (type == CSmsPDU::ESmsSubmit));

	} // CSmsIEOperation::MessageTypeSupported

CSmsIEOperation::CSmsIEOperation(CSmsInformationElement::TSmsInformationElementIdentifier aId, CSmsMessage& aMessage) : iId(aId), iMessage(aMessage)

	{

	//NOP

	} // CSmsIEOperation::CSmsIEOperation

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the assignment operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

void CSmsIEOperation::operator=(const CSmsIEOperation&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsIEOperation::operator=");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the equality operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

TBool CSmsIEOperation::operator==(const CSmsIEOperation&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsIEOperation::operator==");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    return EFalse;

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the assignment operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

void CSmsCtrlOperation::operator=(const CSmsCtrlOperation&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsCtrlOperation::operator=");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the equality operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

TBool CSmsCtrlOperation::operator==(const CSmsCtrlOperation&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsCtrlOperation::operator==");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    return EFalse;

    BULLSEYE_RESTORE

    }

CSmsCtrlOperation::CSmsCtrlOperation(CSmsInformationElement::TSmsInformationElementIdentifier aId, CSmsMessage& aMessage) : CSmsIEOperation(aId, aMessage)

	{

	//NOP

	} // CSmsCtrlOperation::CSmsCtrlOperation

CSmsHyperLinkOperations::CSmsHyperLinkOperations(CSmsInformationElement::TSmsInformationElementIdentifier aId, CSmsMessage& aMessage) : CSmsCtrlOperation(aId, aMessage)

	{

	//NOP

	} // CSmsHyperLinkOperations::CSmsHyperLinkOperations

void CSmsIEOperation::ConstructL()

	{

	LOGGSMU1("CSmsIEOperation::ConstructL()");

	} // CSmsIEOperation::ConstructL

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the assignment operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

void CSmsHyperLinkOperations::operator=(const CSmsHyperLinkOperations&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsHyperLinkOperations::operator=");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the equality operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

TBool CSmsHyperLinkOperations::operator==(const CSmsHyperLinkOperations&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsHyperLinkOperations::operator==");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    return EFalse;

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Identifies whether the message type or version supports this operation

 *  

 *  @leave

 *  If the message type or version does not support this operation.

 */

void CSmsHyperLinkOperations::ValidateOperationL() const

	{

	LOGGSMU1("CSmsHyperLinkOperations::ValidateOperationL()");

	if (iMessage.Version() < CSmsMessage::ESmsMessageV1)

	    {

	    LOGGSMU2("CSmsHyperLinkOperations::AddHyperLinkL, Operation not supported, Msg Version %d", iMessage.Version());

	    User::Leave(KErrNotSupported);

	    }

	if (!MessageTypeSupported())

	    {

	    LOGGSMU2("CSmsHyperLinkOperations::AddHyperLinkL, Operation not supported by this PDU type, type = %d", iMessage.Type());

	    User::Leave(KErrNotSupported);

	    }

	} // CSmsHyperLinkOperations::ValidateOperationL

/**

 *  @publishedAll

 *  

 *  This method adds a HyperLink to the CSmsMessage.

 *  

 *  @param aPosition

 *  The absolute character position within the message text.

 *  @param aTitle

 *  An integer representation of the number of characters in the hyperlink title.

 *  @param URL Length

 *  An integer representation of the number of characters in the URL.

 *  @leave KErrNotSupported

 *  If the message version or type does not support hyperlinks.

 *  @capability None

 */

EXPORT_C void CSmsHyperLinkOperations::AddHyperLinkL(TUint aPosition, TUint8 aTitleLength,  TUint8  aURLLength) const

	{

	LOGGSMU1("CSmsHyperLinkOperations::AddHyperLinkL()");

	ValidateOperationL();

	CSmsMessageAdditionalAttributes& additionalAttributes = *((CSmsMessageAdditionalAttributes*) iMessage.AdditionalInfo());

	TBuf8 <4> buffer;

	buffer.SetLength(4);

	buffer[0] = (TUint8) (aPosition >> 8); // lowest octet contains the

	buffer[1] = (TUint8)  aPosition;       // most significant bits

	buffer[2] = aTitleLength;

	buffer[3] = aURLLength;

	CSmsInformationElement* iE = CSmsInformationElement::NewL(CSmsInformationElement::ESmsHyperLinkFormat, buffer);

	CleanupStack::PushL(iE);

	additionalAttributes.AddControlInformationElementL(iE);

	CleanupStack::Pop(iE);

	} // CSmsHyperLinkOperations::AddHyperLinkL

/**

 *  @publishedAll

 *  

 *  Returns the number of Hyper Link IEs contained in this message.

 *  @leave KErrNotSupported

 *  If this functionality is not supported by this version or type of message.

 *  @return

 *  The number of hyper links contained in this message.

 *  @capability None

 */

EXPORT_C TUint CSmsHyperLinkOperations::NumberOfHyperLinksL() const

	{

	LOGGSMU1("CSmsHyperLinkOperations::NumberOfHyperLinks");

	ValidateOperationL();

	TUint numberOfHyperLinks = 0;

	TSmsInformationElementCategories::TInformationElementCategory category;

	if (TSmsInformationElementCategories::GetCategoryDefinition(CSmsInformationElement::ESmsHyperLinkFormat, category) == EFalse)

			{

		User::Leave(KErrArgument);

		}

	CSmsMessageAdditionalAttributes* additionalAttributes = (CSmsMessageAdditionalAttributes*) iMessage.AdditionalInfo();

	TUint numberOfElements = additionalAttributes->NumberOfControlInformationElements(category);

	for (TUint i = 0; i < numberOfElements; i++)

	    {

	    CSmsInformationElement::TSmsInformationElementIdentifier id = CSmsInformationElement::ESmsIEMaximum;

	    // If function leaves, allow the error to propagate upwards

	    id = additionalAttributes->GetControlInformationElementL(category, i).Identifier();

	    if (id == CSmsInformationElement::ESmsHyperLinkFormat)

	        {

	        numberOfHyperLinks++;

	        }

	    }

	return numberOfHyperLinks;

	} // CSmsHyperLinkOperations::NumberOfHyperLinksL

/**

 *  @publishedAll

 *  

 *  Copies the attributes of the specified hyperlink.

 *  aIndex has the range [0..[n-1]] where n is the

 *  value returned by NumberOfHyperLinks()

 *  

 *  @param aIndex

 *  Identifies the hyperlink to extract. Has the range [0..[n-1]]

 *  where n is the value returned by NumberOfHyperLinks().

 *  @param &aPosition

 *  The absolute character position within the message text.

 *  @param &aTitleLength

 *  An integer representation of the number of characters in the hyperlink title.

 *  @param &aURLLength

 *  An integer representation of the number of characters in the URL.

 *  @leave KErrNotSupported

 *  If the message version or type does not support hyperlinks.

 *  @leave KErrArgument

 *  If aIndex is out of range.

 *  @capability None

 */

EXPORT_C void  CSmsHyperLinkOperations::CopyHyperLinkAtIndexL(TUint aIndex, TUint& aPosition, TUint8& aTitleLength,  TUint8&  aURLLength) const

	{

	LOGGSMU2("CSmsHyperLinkOperations::CopyHyperLinkAtIndexL(): aIndex=%d", aIndex);

	ValidateOperationL();

	TUint numberOfHyperLinks = 0;

	TSmsInformationElementCategories::TInformationElementCategory category;

	if (TSmsInformationElementCategories::GetCategoryDefinition(CSmsInformationElement::ESmsHyperLinkFormat, category) == EFalse)

		{

		User::Leave(KErrArgument);

		}

	CSmsMessageAdditionalAttributes* additionalAttributes = (CSmsMessageAdditionalAttributes*) iMessage.AdditionalInfo();

	TUint numberOfElements = additionalAttributes->NumberOfControlInformationElements(category);

	if (aIndex >= numberOfElements)

	    {

	    User::Leave(KErrArgument);

	    }

	for (TUint i = 0; i < numberOfElements; i++)

	    {

	    CSmsInformationElement::TSmsInformationElementIdentifier id = CSmsInformationElement::ESmsIEMaximum;

	    // If function leaves, allow the error to propagate upwards

	    id = additionalAttributes->GetControlInformationElementL(category, i).Identifier();

	    if ((id == CSmsInformationElement::ESmsHyperLinkFormat) &&

	        (numberOfHyperLinks++ == aIndex))

	        {

	        aPosition     = (additionalAttributes->GetControlInformationElementL(category, i).Data()[0] << 8);

	        aPosition    +=  additionalAttributes->GetControlInformationElementL(category, i).Data()[1];

	        aTitleLength = additionalAttributes->GetControlInformationElementL(category, i).Data()[2];

	        aURLLength   = additionalAttributes->GetControlInformationElementL(category, i).Data()[3];

	        break;

	        }

	    }

	} // CSmsHyperLinkOperations::CopyHyperLinkAtIndexL

/**

 *  @publishedAll

 *  

 *  Removes all hyper Link IEs contained in this message.

 *  

 *  @leave KErrNotSupported

 *  If the message version or type does not support hyperlinks.

 *  @capability None

 */

EXPORT_C void  CSmsHyperLinkOperations::RemoveAllHyperLinksL() const

	{

	LOGGSMU1("CSmsHyperLinkOperations::RemoveAllHyperLinks");

	ValidateOperationL();

	TSmsInformationElementCategories::TInformationElementCategory category;

	if (TSmsInformationElementCategories::GetCategoryDefinition(CSmsInformationElement::ESmsHyperLinkFormat, category) == EFalse)

		{

		User::Leave(KErrArgument);

		}

	CSmsMessageAdditionalAttributes* additionalAttributes = (CSmsMessageAdditionalAttributes*) iMessage.AdditionalInfo();

	TUint i = additionalAttributes->NumberOfControlInformationElements(category);

	while (i-- != 0)

	    {

	    CSmsInformationElement::TSmsInformationElementIdentifier id = CSmsInformationElement::ESmsIEMaximum;

	    // If function leaves, allow the error to propagate upwards

	    id = additionalAttributes->GetControlInformationElementL(category, i).Identifier();

	    if (id == CSmsInformationElement::ESmsHyperLinkFormat)

	        {

	        additionalAttributes->DeleteControlInformationElement(category, i);

	        }

	    }

	} // CSmsHyperLinkOperations::RemoveAllHyperLinksL

/**

 *  @publishedAll

 *  

 *  Removes the indexed hyperlink from this message.

 *  

 *  @param aIndex

 *  aIndex has the range [0..[n-1]] where n is the

 *  value returned by NumberOfHyperLinks()

 *  @leave KErrNotSupported

 *  If the message version or type does not support hyperlinks.

 *  @leave KErrArgument

 *  If the index is out of range.

 *  @capability None

 */

EXPORT_C void  CSmsHyperLinkOperations::RemoveHyperLinkL(TUint aIndex) const

	{

	LOGGSMU1("CSmsHyperLinkOperations::RemoveHyperLink");

	ValidateOperationL();

	TUint numberOfHyperLinks = 0;

	TSmsInformationElementCategories::TInformationElementCategory category;

	if (TSmsInformationElementCategories::GetCategoryDefinition(CSmsInformationElement::ESmsHyperLinkFormat, category) == EFalse)

		{

		User::Leave(KErrArgument);

		}

	CSmsMessageAdditionalAttributes* additionalAttributes = (CSmsMessageAdditionalAttributes*) iMessage.AdditionalInfo();

	TUint numberOfElements = additionalAttributes->NumberOfControlInformationElements(category);

	if (aIndex >= numberOfElements)

	    {

	    User::Leave(KErrArgument);

	    }

	for (TUint i = 0; i < numberOfElements; i++)

	    {

	    CSmsInformationElement::TSmsInformationElementIdentifier id = CSmsInformationElement::ESmsIEMaximum;

	    // If function leaves, allow the error to propagate upwards

	    id = additionalAttributes->GetControlInformationElementL(category, i).Identifier();

	    if ((id == CSmsInformationElement::ESmsHyperLinkFormat) &&

	        (numberOfHyperLinks++ == aIndex))

	        {

	        additionalAttributes->DeleteControlInformationElement(category, i);

	        break;

	        }

	    }

	} // CSmsHyperLinkOperations::RemoveHyperLinkL

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the assignment operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None

 */

void CSmsReplyAddressOperations::operator=(const CSmsReplyAddressOperations&)

    {

    // Ignore in code coverage - not intended to be used

    BULLSEYE_OFF    

    LOGGSMU1("CSmsReplyAddressOperations::operator=");

    Panic(KGsmuPanicMethodBodyNotImplemented1);

    BULLSEYE_RESTORE

    }

/**

 *  @internalComponent

 *  

 *  Prevent clients from using the equality operator by including it in the class definition

 *  but making it protected and not exporting it.

 *  

 *  @capability None