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

// Unit tests for functionality delivered by the CNTVCARD.DLL library.

// This test contains the tests originally in T_EXPDEL

// 

//

#include <e32test.h>

#include <f32file.h>

#include <s32file.h>

#include <s32mem.h>

#include <cntdb.h>

#include <cntvcard.h>

#include <cntitem.h>

#include <cntfldst.h>

#include <e32def.h>

#include "t_utils2.h"

#include "T_rndutils.h"

#include <coreappstest/testserver.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include "cntdb_internal.h"

#endif

_LIT(KTestName,"T_CNTVCARD");

_LIT(KDatabaseFileName,"C:T_CNTVCARD");

_LIT(KVcard1, "Z:\\t_cntvcard\\email1.vcf");

_LIT(KVcard2, "Z:\\t_cntvcard\\email2.vcf");

_LIT(KOutputFileName, "C:\\Test_Output.txt");

_LIT(KExpDelAFileName, "c:\\expdela");

_LIT(KTestVcardFile, "Z:\\cntvcard\\testvcard.vcf");

_LIT(KImpTypeVcardName, "Z:\\t_cntvcard\\testTypeVcard.vcf");

_LIT(KImpNoTypeVcardName, "Z:\\t_cntvcard\\testNoTypeVcard.vcf");

_LIT(KTestVcardFile1, "Z:\\cntvcard\\testvcard1.vcf");

//UpdateVCardL

_LIT(KVCardUpdate1,"Z:\\System\\Programs\\CntmodelTest\\vcardupdate1.vcf");

_LIT(KVCardUpdate2,"C:\\vcardupdate2.vcf");

_LIT(KVCardUpdate3,"Z:\\System\\Programs\\CntmodelTest\\vcardupdate3.vcf");

// digram data files

_LIT(KFirstNameFileName,"z:\\cntvcard\\names.first.2gm");

_LIT(KLastNameFileName,"z:\\cntvcard\\names.last.2gm");

// vcard terminated by LF

_LIT(KVCardFileLF,"z:\\t_cntvcard\\cntvcardLF.vcf");

// vcard containing UID property

_LIT(KVCardFileUID,"z:\\t_cntvcard\\cntvcardUID.vcf");

_LIT8(KVCardBinaryKeyImportFileDes,"BEGIN:VCARD\r\n"

							"VERSION:2.1\r\n"

							"REV:20061120T111808Z\r\n"

							"UID:0000000000000000-00e1005eee8a27d8-44\r\n"

							"N:Name;;;;\r\n"

							"TEL;HOME;VOICE;CELL:1111\r\n"

							"KEY;ENCODING=BASE64:MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvcNAQEEBQA\r\n"

							"wdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENbW11bmljYX\r\n"

							"Rpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0\r\n"

							"ZW1zMRwwGgYDVQQDExNyb290Y2EubmV0c2NhcGUuY29tMB4XDTk3MDYwNj\r\n"

							"E5NDc1OVoXDTk3MTIwMzE5NDc1OVowgYkxCzAJBgNVBAYTAlVTMSYwJAYD\r\n"							 

							"VQQKEx1OZXRzY2FwZSBDb21tdW5pY2F0aW9ucyBDb3JwLjEYMBYGA1UEAx\r\n"

							"MPVGltb3RoeSBBIEhvd2VzMSEwHwYJKoZIhvcNAQkBFhJob3dlc0BuZXRz\r\n"

							"Y2FwZS5jb20xFTATBgoJkiaJk/IsZAEBEwVob3dlczBcMA0GCSqGSIb3DQ\r\n"

							"EBAQUAA0sAMEgCQQC0JZf6wkg8pLMXHHCUvMfL5H6zjSk4vTTXZpYyrdN2\r\n"

							"dXcoX49LKiOmgeJSzoiFKHtLOIboyludF90CgqcxtwKnAgMBAAGjNjA0MB\r\n"

							"EGCWCGSAGG+EIBAQQEAwIAoDAfBgNVHSMEGDAWgBT84FToB/GV3jr3mcau\r\n"

							"+hUMbsQukjANBgkqhkiG9w0BAQQFAAOBgQBexv7o7mi3PLXadkmNP9LcIP\r\n"

							"mx93HGp0Kgyx1jIVMyNgsemeAwBM+MSlhMfcpbTrONwNjZYW8vJDSoi//y\r\n"

							"rZlVt9bJbs7MNYZVsyF1unsqaln4/vy6Uawfg8VUMk1U7jt8LYpo4YULU7\r\n"

							"UZHPYVUaSgVttImOHZIKi4hlPXBOhcUQ==\r\n"

							"\r\n"

							"PHOTO;ENCODING=BASE64:\r\n"

							"   ZmlsZTovLy9qcXB1YmxpYy5naWY=\r\n"

							"\r\n"

							"END:VCARD\r\n"

							);

_LIT8(KVCardTextKeyImportFileDes,"BEGIN:VCARD\r\n"

							"VERSION:2.1\r\n"

							"REV:20061120T111808Z\r\n"

							"UID:0000000000000000-00e1005eee8a27d8-44\r\n"

							"N:Name;;;;\r\n"

							"TEL;HOME;VOICE;CELL:1111\r\n"

							"KEY:X509\r\n"

							"PHOTO;ENCODING=BASE64:\r\n"

							"   ZmlsZTovLy9qcXB1YmxpYy5naWY=\r\n"

							"\r\n"

							"END:VCARD\r\n"

							);

_LIT8(KMultiParam,"BEGIN:VCARD\r\n"

				"VERSION:2.1\r\n"

				"N:;Neo;;Mr.;\r\n"

				"FN:Mr. TestName\r\n"

				"TEL;TYPE=HOME;TYPE=VOICE;TYPE=CELL:123\r\n"

				"END:VCARD\r\n"

				);

_LIT8(KTelExport, "TEL;HOME;VOICE;CELL:123\r\n");

_LIT8(KVCardBeforeChange,"BEGIN:VCARD\r\n"

 						"VERSION:2.1\r\n"

 						"N:Jm;Jg;;;\r\n"

 						"TEL;HOME:11111\r\n"

 						"TEL;HOME:67890\r\n"

 						"TEL;CELL:12345\r\n"

 						"UID:4c2d2b19ef07adea-00e115956542fd28-1\r\n"

 						"END:VCARD\r\n"

 						);

 _LIT8(KVCardAfterChange,"BEGIN:VCARD\r\n"

 						"VERSION:2.1\r\n"

 						"N:Jm;Jg;;;\r\n"

 						"TEL;HOME:11112\r\n"

 						"TEL;HOME:22222\r\n"

 						"TEL;HOME:22223\r\n"

 						"TEL;HOME:22224\r\n"

 						"UID:4c2d2b19ef07adea-00e115956542fd28-1\r\n"

 						"END:VCARD\r\n"

 						);				

 _LIT(KGivenName, "Jg");

 _LIT(KFamilyName, "Jm");

 _LIT(KTelHome1,"11111");

 _LIT(KTelHome2,"67890");

 _LIT(KTelCell,"12345");

 _LIT(KTelHome1Modified,"11112");

 _LIT(KTelHome2Modified,"22222");

 _LIT(KTelHome3Modified,"22223");

 _LIT(KTelHome4Modified,"22224");

//vCard containing CompanyField

_LIT(KVCardWithCompany, "z:\\t_cntvcard\\withcompany.vcf");

//vCard without CompanyField

_LIT(KVCardWithoutCompany, "z:\\t_cntvcard\\withoutcompany.vcf");

_LIT(KVCardLargePhoto, "Z:\\t_cntvcard\\vcardwithlargephoto.vcf");

CCntTest* CntTest=NULL;

LOCAL_D RTest test(KTestName);

LOCAL_C void TestCondition(TBool aCondition, TInt aLineNumber);

#define TEST_CONDITION(x) TestCondition(x, __LINE__)

const TInt KNumAccessCountContacts= 5;

const TInt KMachineUniqueId=0;

const TInt KNumberOfRandomContacts = 40;

_LIT(KName,"Name");

_LIT(KPhoneNumber,"1111");

_LIT8(KModifiedNumberProperty,"TEL;HOME;CELL:11112222\r\n"); //no VOICE parameter!

_LIT8(KModifiedNumberProperty2,"tel;work;cell;2:4444\r\ntel;home;Voice;CELL:\r\n"); //empty property to delete

_LIT8(KModifiedNumberProperty3,"TEL;HOME;CELL:\r\nTEL;HOME;CELL:3333\r\n"); 

_LIT(KVCardFile1,"c:\\cntvcard1.vcf");

_LIT(KVCardFile2,"c:\\cntvcard2.vcf");

_LIT(KVCardFile3,"c:\\cntvcard3.vcf");

// data we expect to see in KTestVcardFile

_LIT(KFirstName, "first");

_LIT(KFirstNamePrn, "f-i-r-s-t");

_LIT(KSurName, "last");

_LIT(KSurNamePrn, "l-a-s-t");

_LIT(KOrgName, "I work here");

_LIT(KOrgNamePrn, "Eye w-o-r-k h-e-r-e");

// labels we expect from the conacts resource file

_LIT(KFirstNameLabel, "First name");

_LIT(KFirstNamePrnLabel, "First name reading");

_LIT(KSurNameLabel, "Last name");

_LIT(KSurNamePrnLabel, "Last name reading");

_LIT(KOrgNameLabel, "Company");

_LIT(KOrgNamePrnLabel, "Company reading");

_LIT(KVCardFile5, "c:\\cntvcard5.vcf");

_LIT(KVCardFile6, "c:\\cntvcard6.vcf");

_LIT8(KMasterVcard, "BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131829Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015e3ec0-18\r\n"

					"N:Aaaa;Pekka;;;\r\n"

					"END:VCARD\r\n"

					"BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131916Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015e8128-19\r\n"

					"N:Bbb;Pekka;;;\r\n"

					"END:VCARD\r\n"

					"BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131829Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015eb46d-20\r\n"

					"N:Cccc;Pekka;;;\r\n"

					"END:VCARD\r\n"

);

_LIT8(KModifierVcard,"BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131829Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015e3ec0-18\r\n"

					"N:Aaaa;Pekka;;;\r\n"

					"END:VCARD\r\n"

					"BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131916Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015e8128-19\r\n"

					"N:;Pekka;;;\r\n"

					"END:VCARD\r\n"

					"BEGIN:VCARD\r\n"

					"VERSION:2.1\r\n"

					"REV:20060821T131829Z\r\n"

					"UID:f356da00bfd5320f-00e0f93a015eb46d-20\r\n"

					"N:Cccc;Pekka;;;\r\n"

					"END:VCARD\r\n"

);

_LIT8(KPartialVCard,"BEGIN:VCARD\r\n"

        "\r"

);

const TAny* GNames[]  = {&KFirstName, &KFirstNamePrn, &KSurName, &KSurNamePrn, &KOrgName, &KOrgNamePrn};

const TAny* GLabels[]  = {&KFirstNameLabel, &KFirstNamePrnLabel, &KSurNameLabel, &KSurNamePrnLabel, &KOrgNameLabel, &KOrgNamePrnLabel};

const TInt KNumberOfExtendedFieldNames=6;

const TInt KExtendedFieldNames[KNumberOfExtendedFieldNames] = 

	{

	KUidContactFieldGivenNameValue, 

	KUidContactFieldGivenNamePronunciationValue,

	KUidContactFieldFamilyNameValue, 

	KUidContactFieldFamilyNamePronunciationValue,

	KUidContactFieldCompanyNameValue, 	

	KUidContactFieldCompanyNamePronunciationValue, 

	};

/** Tests for default VOICE property parameter handling (tests1-4), and the X-IRMC-x extentions for the SOUND property (tests 5-6) */

class CDefaultVoiceParamTests : public CBase

	{

public :

	enum THowToCheck {ECheckValue = 1, ECheckLabel = 2, EAppendValue = 4, EAppendLabel = 8};

public:

	static CDefaultVoiceParamTests* NewLC(CCntTest& aTestLibrary);

	~CDefaultVoiceParamTests();

	void RunTestsL();

private:

	CDefaultVoiceParamTests(CCntTest& aTestLibrary);

	void ConstructL();

	void TestOneL();

	void TestTwoL();

	void TestThreeL();

	void TestFourL();

	void TestFiveL();

	void TestSixL();

	void ImportContactsL(const TDesC& aFileName);

	void ExportContactsL(const TDesC& aFileName, const CContactIdArray* aIds);

	void CreateTestDataL(TContactItemId aId, const TDesC& aFileName, const TDesC8& aVCardData);

	TInt CountPhoneNumberFieldsL(TContactItemId aId);

	TContactItemId CreateItemL(const TDesC& aName, const TDesC& aNumber);

	static void CheckCard(CContactCard* aCard,  CDesCArray* aFields = NULL, CDesCArray* aLabels =NULL, TUint aFlags = ECheckValue|ECheckLabel);

	void CheckCardL(TContactItemId aId,  CDesCArray* aFields = NULL, CDesCArray* aLabels =NULL, TUint aFlags = ECheckValue|ECheckLabel) const;

private:

	CCntTest& iTest;

	CContactDatabase* iDb;

	};

CDefaultVoiceParamTests* CDefaultVoiceParamTests::NewLC(CCntTest& aTestLibrary)

	{

	CDefaultVoiceParamTests* self = new(ELeave) CDefaultVoiceParamTests(aTestLibrary);

	CleanupStack::PushL(self);

	self->ConstructL();

	return self;

	}

CDefaultVoiceParamTests::~CDefaultVoiceParamTests()

	{

	}

void CDefaultVoiceParamTests::RunTestsL()

	{

	TestFiveL(); //these two have to run 1st since tests 1-4 leave the db in an inconvenient state

	TestSixL();

	TestOneL();

#if defined(_DEBUG)

	//this test cannot be run in release mode due to UID mismatch.

	TestTwoL();

#endif

	TestThreeL();

	TestFourL();	

	}

CDefaultVoiceParamTests::CDefaultVoiceParamTests(CCntTest& aTestLibrary) : iTest(aTestLibrary)

	{

	}

void CDefaultVoiceParamTests::ConstructL()

	{

	iDb=iTest.CreateDatabaseL();

	iDb->OverrideMachineUniqueId(KMachineUniqueId); 

	}

/** Check all the fields specified by KExtendedFieldNames for correctness.

	The specific behaviour on what is checked is regulated by aFlags. 

	This also prints each field with its label.

	@param aFields 	If present and the ECheckValue bit of aFlags set, the nth field text value is compared against

					the nth descriptor in aFields. 

					If present and EAppendValue bit of aFlags set, each field's text value is appended to the end of aFields. 	

	@param aLabels 	If present and the ECheckLabel bit of aFlags set, the nth field's label is compared against

					the nth descriptor in ECheckLabel. 

					If present and EAppendLabel bit of aFlags set, each field's label is appended to the end of aLabels. 

	@param aFlags	Bitfields indicating how aFields and aLabels are used. Note that some values from THowToCheck

					 (like ECheckValue and EAppendValue) cannot be used at the same time.

 */

void CDefaultVoiceParamTests::CheckCard(CContactCard* aCard,  CDesCArray* aFields, CDesCArray* aLabels, TUint aFlags)

	{

	CContactItemFieldSet& fieldSet=aCard->CardFields();

	for(TInt i=0;i<KNumberOfExtendedFieldNames;i++)

		{

		TInt index = fieldSet.Find( TUid::Uid(KExtendedFieldNames[i]));

		TEST_CONDITION(index != KErrNotFound);

      	TPtrC text;

		if(aFields && (ECheckValue& aFlags))

			{

			TPtrC compare((*aFields)[i]);

			TBool succeed(EFalse);

			while(index != KErrNotFound)

                {

    			text.Set(fieldSet[index].TextStorage()->Text());

    			succeed = (text.Compare(compare)==0);

    			if(succeed)

    			    {

    			    break;

    			    }

    			index = fieldSet.FindNext( TUid::Uid(KExtendedFieldNames[i]), index + 1);    

                }

            TEST_CONDITION(succeed);    

			}

		else if (aFields && (aFlags & EAppendValue))

			{

			text.Set(fieldSet[index].TextStorage()->Text());

			TRAP_IGNORE(aFields->AppendL(text));

			}

		TPtrC label(fieldSet[index].Label());

		if(aLabels && (ECheckLabel& aFlags))

			{

			TPtrC comparelabel((*aLabels)[i]);

			TEST_CONDITION(label.Compare(comparelabel)==0);

			}

		else if (aLabels && (aFlags & EAppendLabel))

			{

			TRAP_IGNORE(aLabels->AppendL(label));

			}

		test.Printf(_L("%S: %S\n") ,&label, &text);	// print this just to make sure

		}

}

void CDefaultVoiceParamTests::CheckCardL(TContactItemId aId,  CDesCArray* aFields, CDesCArray* aLabels, TUint aFlags) const

	{

	CContactCard* card = STATIC_CAST(CContactCard*, iDb->OpenContactL(aId));

	CleanupStack::PushL(card);

	CheckCard(card, aFields, aLabels, aFlags);

	iDb->CloseContactL(aId);

	CleanupStack::PopAndDestroy(card);

	}

/** 

Default number is edited in PIM and synchronisation is started. 

Default number is not edited in phone but new number is inserted

1. Choose a phone number field of a phone contact as a default (For example Tel home: 1111)

2. Start synchronisation

3. Edit the contact's default number in PIM (For example Home: 1111 -> 11112222)

4. Start synchronisation

5. Default number wasn't amended in phone but new edited number detail (Tel Home 11112222) was created.

*/

void CDefaultVoiceParamTests::TestOneL()

	{

	TContactItemId id = CreateItemL(KName(),KPhoneNumber());

	CContactIdArray* array = CContactIdArray::NewLC();

	array->AddL(id);

	ExportContactsL(KVCardFile1,array);

	CreateTestDataL(id, KVCardFile2,KModifiedNumberProperty); 

	ImportContactsL(KVCardFile2);

	ExportContactsL(KVCardFile3,array); //for checking

	CleanupStack::PopAndDestroy(array);

	TEST_CONDITION(CountPhoneNumberFieldsL(id)==1); //no new field was created

	}

/**

Case2

Default number is deleted from PIM and new number is created in PIM. 

After synchronisation default number is not deleted from PIM and new number is not created to phone.

(If default number is deleted only and synch is started, default number is not deleted from phone)

	1. Choose a phone number field of a phone contact as a default

		(For example Tel home: 1111)

	2. Start Synchronisation

	3. Delete default number (Home:1111) in PIM and create a new number in PIM (Work2: 4444)

	4. Start synchronisation

	5. Default number wasn't deleted from phone and new number wasn't inserted to phone

*/

void CDefaultVoiceParamTests::TestTwoL()

	{

	TContactItemId id = CreateItemL(KName,KPhoneNumber);

	CContactIdArray* array = CContactIdArray::NewLC();

	array->AddL(id);

	ExportContactsL(KVCardFile1,array);

	CreateTestDataL(id,KVCardFile2,KModifiedNumberProperty2); 

	ImportContactsL(KVCardFile2);

	ExportContactsL(KVCardFile3,array); //for checking

	CleanupStack::PopAndDestroy(array);

	TEST_CONDITION(CountPhoneNumberFieldsL(id)==1); 

	CContactItem* item = iDb->ReadContactLC(id);

	CContactItemFieldSet& fieldSet = item->CardFields();

	TInt pos=fieldSet.Find(KUidContactFieldPhoneNumber);

	while (pos!=KErrNotFound)

		{

		const CContactItemField& field = (fieldSet)[pos];

		if (field.Storage()->IsFull())

			{

			CContactTextField* textfield = field.TextStorage();

			_LIT(KExpectedNumber,"4444");

			TEST_CONDITION(textfield->Text()==KExpectedNumber);

			}

		pos=fieldSet.FindNext(KUidContactFieldPhoneNumber,++pos);

		}

	CleanupStack::PopAndDestroy(item);

	}

/**

Case3

Default number is selected in phone, and same number is edited in PIM. 

After synchronisation edited number is not syncronised at all

	1. Choose a phone number field of a phone contact as a default

		(For example Tel home: 1111)

	2. Edit the same number (phone's default) for example

                         home 1111 to 11114444 in PIM

	3. Start Synchronisation

	4. Default number was not edited in phone. New number was inserted to phone 

	but number was same as the default's number. So, edited number wasn't 

	synchronised at all.

*/

void CDefaultVoiceParamTests::TestThreeL()

	{

	//Not sure how to simulate. I believe this is case is duplicated by TestOneL()

	}

/*

Case 4

Default number is selected in phone, same number is deleted from PIM and new 

number is created in PIM. 

After synchronisation default number is not deleted from PIM but it is duplicated. 

	1. Choose a phone number field of a phone contact as a default

		(For example Tel home: 1111)

	2. Delete the same number (phone's default) in PIM and create a new number in PIM 

	3. Start Synchronisation

	4. Default is not deleted from PIM. New number is inserted to phone but number is 

	same as default's. Number you created in PIM, is copied correctly to phone.

*/

void CDefaultVoiceParamTests::TestFourL()

	{

	TContactItemId id = CreateItemL(KName,KPhoneNumber);

	CContactIdArray* array = CContactIdArray::NewLC();

	array->AddL(id);

	ExportContactsL(KVCardFile1,array);

	CreateTestDataL(id, KVCardFile2,KModifiedNumberProperty3); 

	ImportContactsL(KVCardFile2);

	ExportContactsL(KVCardFile3,array); //for checking

	CleanupStack::PopAndDestroy(array);

	TEST_CONDITION(CountPhoneNumberFieldsL(id)==1); //no new field was created	

	}

/**This checks the contact indentity fields extracted from a known vCard (KTestVcardFile) to ensure

	the contact is exactly what we expect. This tests both the field value and label in the generated contact.

	*/

void CDefaultVoiceParamTests::TestFiveL()

	{

	CDesCArray* value = new(ELeave) CDesCArrayFlat(KNumberOfExtendedFieldNames);

	CleanupStack::PushL(value);

	CDesCArray* label = new(ELeave) CDesCArrayFlat(KNumberOfExtendedFieldNames);	

	CleanupStack::PushL(label);

	for(TInt i=0;i<KNumberOfExtendedFieldNames;i++)

		{

		value->AppendL(*((const TDesC*) GNames[i]));

		label->AppendL(*((const TDesC*) GLabels[i]));

		}

	ImportContactsL(KTestVcardFile);

	const CContactIdArray& list = *iDb->SortedItemsL();

	CheckCardL(list[0], value, label);

	CleanupStack::PopAndDestroy(2,value); // + label

	iDb->DeleteContactL(list[0]);

	}

/** This generates a whole bunch of conacts (KNumberOfRandomContacts) and exports them to a vCard file.

	The contacts are then read back in. This tests the merge functionality of vCard parsing.