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

// Logging macros code specific structures in SMSStack.

// 

//

/**

 @file

 @internalComponent

*/

#include "gsmupdu.h"

#include "smsstacklog.h"

//

// All functions in this file are available only if logging is enabled.

//

#ifdef _SMS_LOGGING_ENABLED

/**

 *  Number of characters per line during hex dump logging.

 */

const TInt  KHexDumpCharsPerLine = 32;

/**

 *  Converts a PDU from a buffer into a ASCII string and decodes it.

 *

 *  @param aPDU         PDU to log.

 *  @param aCommandPdu  Flag to say if this is a command PDU.

 */

void LogSmsIfPDU(const TDesC8& aText, const TDesC8& aPDU, TBool aCommandPdu)

	{

	TBuf8<128>  tmpBuf;

	//

	// Log the PDU as raw hex...

	//

	tmpBuf.Copy(aText);

	tmpBuf.Append(_L8("RAW:  "));

	LOGSMSIFHEXBUF(tmpBuf, aPDU);

	//

	// Log the first octet...

	//

	// bit	   7	6	 5	  4    3	2	 1	  0

	// submit  rp	udhi srr  vpf  vpf	rd	 0	  1  mti, rd,  vpf, rp, udhi, srr,

	// deliver rp	udhi sri			mms  0	  0  mti, mms, rp, udhi, sri

	// status		udhi srq			mms  1	  0  mti, udhi, mms, srq

	// command		udhi srr				 1    0  mti, udhi, srr

	//

	enum TSmsVp

		{

		EVpAbs,

		EVpEnh,

		EVpRel,

		EVpNone,

		};

	CSmsPDU::TSmsPDUType  pduType = (CSmsPDU::TSmsPDUType) -1;

	TInt  octetOffset = 0;

	TText8  firstOctet = aPDU[octetOffset++];

	TBool  udhiPresent = EFalse;

	TSmsVp  vpf = EVpRel;

	tmpBuf.Zero();

	if ((firstOctet & 0x03) == 0x00)

		{

		pduType = CSmsPDU::ESmsDeliver;

		tmpBuf.Append(_L8("DELIVER "));

		}

	else if ((firstOctet & 0x03) == 0x01)

		{

		pduType = CSmsPDU::ESmsSubmit;

		tmpBuf.Append(_L8("SUBMIT  "));

		}

	else if((firstOctet & 0x03) == 0x02)

		{

		if (aCommandPdu)

			{

			pduType = CSmsPDU::ESmsCommand;

			tmpBuf.Append(_L8("COMMAND "));

			}

		else

			{

			pduType = CSmsPDU::ESmsStatusReport;

			tmpBuf.Append(_L8("STATUS  "));

			}

		}

	else

		{

		tmpBuf.Append(_L8("UNKNOWN "));

		}

	if (pduType == CSmsPDU::ESmsSubmit  ||  pduType == CSmsPDU::ESmsDeliver)

		{

		if (firstOctet & 0x80)

			{

			tmpBuf.Append(_L8("    1"));

			}

		else

			{

			tmpBuf.Append(_L8("    0"));

			}

		}

	else

		{

		tmpBuf.Append(_L8("    -"));

		}

	if (firstOctet & 0x40)

		{

		tmpBuf.Append(_L8("    1"));

		udhiPresent = ETrue;

		}

	else

		{

		tmpBuf.Append(_L8("    0"));

		}

	if (firstOctet & 0x20)

		{

		tmpBuf.Append(_L8("    1"));

		}

	else

		{

		tmpBuf.Append(_L8("    0"));

		}

	if (pduType == CSmsPDU::ESmsDeliver  ||  pduType == CSmsPDU::ESmsStatusReport)

		{

		// MMS is Deliver or Status Report PDUs only...

		if (firstOctet & 0x04)

			{

			tmpBuf.Append(_L8("    1"));

			}

		else

			{

			tmpBuf.Append(_L8("    0"));

			}

		}

	else

		{

		tmpBuf.Append(_L8("    -"));

		}

	if (pduType == CSmsPDU::ESmsSubmit)

		{

		// Reject Duplicates and VP is for Sumbit PDUs only.

		if (firstOctet & 0x04)

			{

			tmpBuf.Append(_L8("    1"));

			}

		else

			{

			tmpBuf.Append(_L8("    0"));

			}

		if ((firstOctet & 0x18) == 0x18)

			{

			tmpBuf.Append(_L8("    ABS"));

			vpf = EVpAbs;

			}

		else if ((firstOctet & 0x18) == 0x10)

			{

			tmpBuf.Append(_L8("    REL"));

			vpf = EVpRel;

			}

		else if ((firstOctet & 0x18) == 0x08)

			{

			tmpBuf.Append(_L8("    ENH"));

			vpf = EVpEnh;

			}

		else

			{

			tmpBuf.Append(_L8("    NO "));

			vpf = EVpNone;

			}

		}

	else

		{

		tmpBuf.Append(_L8("    -      -"));

		}

	LOGSMSIF2("%S      HEX   MTI        RP UDHI  SRX  MMS   RD     VP", &aText);

	LOGSMSIF4("%SFO:   0x%02X  %S", &aText, firstOctet, &tmpBuf);

	if (pduType == -1)

		{

		// Not supported!

		return;

		}

	//

	//

	// Message reference (submit, status report and command only)...

	//

	if (pduType == CSmsPDU::ESmsSubmit  ||

	    pduType == CSmsPDU::ESmsStatusReport  ||

	    pduType == CSmsPDU::ESmsCommand)

		{

        LOGSMSIF3("%SMR:   0x%02X", &aText, aPDU[octetOffset]);

        octetOffset++;

		}

	//

	// Command's PID, CT and MN...

	//

	if (pduType == CSmsPDU::ESmsCommand)

		{

		LOGSMSIF3("%SPID:  0x%02X", &aText, aPDU[octetOffset]);

        octetOffset++;

		LOGSMSIF3("%SCT:   0x%02X", &aText, aPDU[octetOffset]);

        octetOffset++;

		LOGSMSIF3("%SMN:   0x%02X", &aText, aPDU[octetOffset]);

        octetOffset++;

		}

	//

	// Log the telephone number...

	//

	TInt  telLength = (TInt) aPDU[octetOffset];

	TInt  typeOfNumber = aPDU[octetOffset+1];

	octetOffset += 2;

	if (telLength >= 0  &&  telLength <= 20)

		{

		// Convert the number to ascii...

		tmpBuf.Zero();

		for (TInt  count = 0;  count < (telLength + 1) / 2;  count++)

			{

			tmpBuf.AppendFormat(_L8("%1X%1X"), aPDU[octetOffset] & 0x0f,

								(aPDU[octetOffset] >> 4) & 0x0f);

			octetOffset++;

			}

		tmpBuf.SetLength(telLength);

		LOGSMSIF4("%STEL:  0x%02X  %S", &aText, typeOfNumber, &tmpBuf);

		}

	else

		{

		LOGSMSIF3("%STEL:  Illegal length value (%d)!", &aText, telLength);

		return;

		}

	//

	// PID and the DCS (submit and deliver only)...

	//

	if (pduType == CSmsPDU::ESmsSubmit  ||  pduType == CSmsPDU::ESmsDeliver)

		{

		LOGSMSIF3("%SPID:  0x%02X", &aText, aPDU[octetOffset]);

		octetOffset++;

		tmpBuf.Zero();

		TInt  dcs = aPDU[octetOffset];

		octetOffset++;

		if ((dcs & 0xF0 != 0xF0)  &&

		    ((dcs & 0xD0) == 0x00  ||  (dcs & 0xC0) == 0xC0  ||

		     (dcs & 0xD0) == 0xD0  ||  (dcs & 0xE0) == 0xE0))

			{

			//

			// Classless messages:

			// 00x0xxxx GSM 7 bit default alphabet with no message class

			// 1100xxxx Message Waiting Indication Group: Discard Message

			// 1101xxxx Message Waiting Indication Group: Store Message

			// 1110xxxx Message Waiting Indication Group: Store Message (UCS2 character set)

			//

			tmpBuf.Append(_L8("NO        "));

			}

		else if ((dcs & 0xC0) == 0x00  ||  (dcs & 0x40) == 0x40  ||  (dcs & 0xF0) == 0xF0)

			{

			//

			// Message has a class:

			// 00xxxxxx General Data Coding indication

			// 01xxxxxx Message Marked for Automatic Deletion Group

			// 1111xxxx Data coding/message class

			//

			if ((dcs & 0x03) == 0x00)		//class 0 sms

				{

				tmpBuf.Append(_L8("0         "));

				}

			else if((dcs & 0x03) == 0x03)	//class 3 sms

				{

				tmpBuf.Append(_L8("3         "));

				}

			else if((dcs & 0x01) == 0x01)	//class 1 sms

				{

				tmpBuf.Append(_L8("1         "));

				}

			else if((dcs & 0x02) == 0x02)	//class 2 sms

				{

				tmpBuf.Append(_L8("2         "));

				}

			}

		else

			{

			//

			// 1000xxxx...1011xxxx Reserved coding groups

			//

			tmpBuf.Append(_L8("NO        "));

			}

		if ((dcs & 0xF0) == 0xF0)

			{

			// Data coding/message class

			if ((dcs & 0x04) == 0x00)

				{

				tmpBuf.Append(_L8(" 7 BIT   "));

				}

			else if ((dcs & 0x04) == 0x04)

				{

				tmpBuf.Append(_L8(" 8 BIT   "));

				}

			}

		else if ((dcs & 0xC0) == 0xC0  ||  (dcs & 0xD0) == 0xD0)

			{

			//Message Waiting Indication: Discard Message or Store Message

			tmpBuf.Append(_L8(" 7 BIT   "));

			}

		else if ((dcs & 0xE0) == 0xE0)

			{

			//Message Waiting Indication: Store Message (UCS2 character set)

			tmpBuf.Append(_L8("16 BIT   "));

			}

		else if ((dcs & 0xC0) == 0x00 ||  (dcs & 0x40) == 0x40)

			{

			// General Data Coding indication or Automatic Deletion Group

			if ((dcs & 0x0C) == 0x00)

				{

				tmpBuf.Append(_L8(" 7 BIT   "));

				}

			else if ((dcs & 0x0C) == 0x0C)

				{

				tmpBuf.Append(_L8("Reserved "));

				}

			else if ((dcs & 0x04) == 0x04)

				{

				tmpBuf.Append(_L8(" 8 BIT   "));

				}

			else if ((dcs & 0x08) == 0x08)

				{

				tmpBuf.Append(_L8("16 BIT   "));

				}

			}

		else

			{

			// Reserved coding groups

			tmpBuf.Append(_L("Reserved "));

			}

		if ((dcs & 0xF0 != 0xF0)  &&

		    ((dcs & 0xC0) == 0xC0  ||  (dcs & 0xD0) == 0xD0  ||  (dcs & 0xE0) == 0xE0))

			{

			if ((dcs & 0x03) == 0x00)

				{

				// Voicemail Message Waiting

				tmpBuf.Append(_L8("Voicemail Message Waiting"));

				}

			else if ((dcs & 0x03) == 0x03)

				{

				// Other Message Waiting

				tmpBuf.Append(_L8("Other Message Waiting"));

				}

			else if ((dcs & 0x01) == 0x01)

				{

				// Fax Message Waiting

				tmpBuf.Append(_L8("Fax Message Waiting"));

				}

			else if ((dcs & 0x02) == 0x02)

				{

				// Electronic Mail Message Waiting

				tmpBuf.Append(_L8("Electronic Mail Message Waiting"));

				}

			else

				{

				tmpBuf.Append(_L8("-"));

				}

			}

		else

			{

			tmpBuf.Append(_L8("-"));

			}

		LOGSMSIF2("%SDCS:  HEX   CLASS      DCS     INDICATION TYPE", &aText);

		LOGSMSIF4("%S      0x%02X  %S", &aText, dcs, &tmpBuf);

		}

	//

	// VP (submit only)...

	//

	if (pduType == CSmsPDU::ESmsSubmit)

		{

		if (vpf == EVpRel)

			{

			LOGSMSIF3("%SVP:   %d (Relative)", &aText, aPDU[octetOffset++]);

			}

		else if (vpf == EVpAbs)

			{

			// absolute format	  -  TODO to look for the right format

			tmpBuf.Zero();

			for (TInt index = 0;  index < 7;  index++)

				{

				tmpBuf.AppendFormat(_L8("%02X"), aPDU[octetOffset + index]);

				}

			LOGSMSIF3("%SVP:   %S (Absolute)", &aText, &tmpBuf);

			octetOffset += 7;

			}

		else if (vpf == EVpEnh)

			{

			// enhanced validity period   -  TODO to look for the right format

			tmpBuf.Zero();

			for (TInt index = 0;  index < 7;  index++)

				{

				tmpBuf.AppendFormat(_L8("%02X"), aPDU[octetOffset + index]);

				}

			LOGSMSIF3("%SVP:   %S (Enhanced)", &aText, &tmpBuf);

			octetOffset += 7;

			}

		}

	//

	// SCTS (deliver and status)  -  TODO to look for the right format

	//

	if (pduType == CSmsPDU::ESmsDeliver  ||  pduType == CSmsPDU::ESmsStatusReport)

		{

		tmpBuf.Zero();

		for (TInt index = 0;  index < 7;  index++)

			{

			tmpBuf.AppendFormat(_L8("%02X"), aPDU[octetOffset + index]);

			}

		LOGSMSIF3("%SSCTS: %S", &aText, &tmpBuf);

		octetOffset += 7;

		}

	//

	// Getting the DT and the status of the SR (SR only)

	// TODO	to look for some appended octet after the status, eg. carried ud

	//      and to analise the status

	//

	if (pduType == CSmsPDU::ESmsStatusReport)

		{

		tmpBuf.Zero();

		for (TInt index = 0;  index < 7;  index++)

			{

			tmpBuf.AppendFormat(_L8("%02X"), aPDU[octetOffset + index]);

			}

		LOGSMSIF3("%SDT:   %S", &aText, &tmpBuf);

		octetOffset += 7;

		LOGSMSIF3("%SST:   %02X", &aText, aPDU[octetOffset]);

		octetOffset++;

		}

	//

	// Getting the UDL   -    TODO to add UD later and to decode the UDH

	//

	if (pduType == CSmsPDU::ESmsDeliver  ||  pduType == CSmsPDU::ESmsSubmit)

		{

		if (udhiPresent)

			{

			TInt  udl  = aPDU[octetOffset++];

			TInt  udhl = aPDU[octetOffset++];

			if (udhl > 1)

				{

				tmpBuf.Zero();

				// getting iei_a

				TInt  iei_a = aPDU[octetOffset++];

				// getting ieidl_a

				TInt  ieidl_a = aPDU[octetOffset++];

				if (ieidl_a < udhl)

					{

					//

					// With EDS, IEIDL can  be almost the whole payload; need to limit

					// length of debug or increase udlbuf2 to around 300 bytes (which would

					// make stack frame around 700 bytes out of allowed 2kB; seems too much)

					// TODO: think whether we should explicitly show this truncation, eg with "..."

					//

					for (TInt index = 0;  index < ieidl_a;  index++)

						{

						tmpBuf.AppendFormat(_L8("%02X"), aPDU[octetOffset + index]);

						if (tmpBuf.Length() > tmpBuf.MaxLength() - 2  ||

							octetOffset + index == aPDU.Length() - 1)

							{

							break;

							}

						}

					}

				else

					{

					LOGSMSIF3("%SUDL:  Problems with the ieidl_a %d being less that UDHL",

							  &aText, ieidl_a);

					}