summaryrefslogtreecommitdiffstats
path: root/plugins/contacts/symbian/contactsmodel/cntvcard/cntvcardutils.h
blob: 4fe7d2b1488d74b06c38f09c112378fa38946cef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*
* Copyright (c) 2003-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: 
*
*/


#ifndef __CNTVCARDUTILS_H__
#define __CNTVCARDUTILS_H__

#include <cntvcard.h>
#include "pbapconverter.h"

// Constants
const TUint KContactVCardSpaceCharacter = 0x20;
const TInt KContactMaxVCardPropertyNameLength=75;
const TInt KContactStandardCardValueLength=40;
_LIT(KSingleSpacePropertyValue," ");

// Literal constants
_LIT8(KContactVCardXDashEPOCCNTMODEL,"X-EPOCCNTMODEL");
_LIT(KContactVarVCardXDashEPOCCNTMODEL,"X-EPOCCNTMODEL");
_LIT(KContactVCardFIELDLABEL,"FIELDLABEL");
_LIT8(KContactVCardLABELn,"LABEL%d");
_LIT(KContactVarVCardLABELn,"LABEL%d");
_LIT(KContactVCardLABEL0 ,"LABEL0");
_LIT(KContactVCardLABEL1 ,"LABEL1");
_LIT(KContactVCardLABEL2 ,"LABEL2");
_LIT(KContactVCardLABEL3 ,"LABEL3");
_LIT(KContactVCardLABEL4 ,"LABEL4");
_LIT(KContactVCardLABEL5 ,"LABEL5");
_LIT(KContactVCardLABEL6 ,"LABEL6");
_LIT(KContactVCardFIELDHIDDEN,"FIELDHIDDEN");
_LIT(KContactVCardFIELDREADONLY,"FIELDREADONLY");
//
_LIT(KContactVCardCompositeSupportedButEmptyFieldValue, " ");
_LIT(KContactVCardCompositeUnsupportedFieldValue, "");
_LIT(KContactVCardNonCompositeEmptyFieldValue, "");
_LIT(KContactVCardEmptyFieldValue, "");
_LIT8(KVersitTokenSIPID,"X-SIP");
_LIT8(KVersitParamPOC,"POC");
_LIT8(KVersitParamSWIS,"SWIS");
_LIT8(KVersitParamVOIP,"VOIP");
_LIT8(KVersitTokenWVID,"X-WV-ID");


/**
Export converter, Converts contact items into vCard objects.
also provides support for export of contacts to PBAP client.
 */
class CContactsAppToVCardConverter : public CBase
	{
public:
	~CContactsAppToVCardConverter();
	CContactsAppToVCardConverter(TInt64 aMachineUniqueId, Versit::TVersitCharSet aCharSet, TVCardVersion aVCardVersion);
	CParserVCard* GetContactItemAsVCardL(CContactItem* aMainItem, CArrayPtr<CContactItem>* aAgentItemArray, TInt aOption, TBool aExportPrivateFields);
	void SetFilter(TInt64 aFilter);
	TBool NeedsToBeExported(TPBAPProperties aProp) const;
	TBool IsPBAPExport()const;
private:
	void EncodeItemPropertiesL(const CContactItem& aContactItem,TInt aOption);
	void EncodeFieldPropertiesL(const CContactItem& aContactItem, CArrayPtr<CContactItem>* aAgentItemArray, TInt aOption, TBool aExportPrivateFields);
 	void GetVCardNamePrnL(CContactItemFieldSet& aFields,TInt aOption,TBool aExportPrivateFields);
	void GetVCardNameL(CContactItemFieldSet& aFields,TInt aOption, TBool aExportPrivateFields);
	void GetVCardAddressL(const CContactItem& aContact, TUid aVCardMapping, const TDesC8& aToken, TInt aOption, TBool aExportPrivateFields);
	void MapContactFieldToVCardPropertyL(const CContactItemField& aField,CContactItem* aAgent,TInt aOption,TInt aDuplicateCount,TBool aExportPrivateFields);
	void MapContactMappingToVCardPropertyNameAndTypeL(const CContentType& aContactType,TDes8& aName,TUid& aPropertyUid,CArrayPtr<CParserParam>* aArrayOfParams) const;
	void RetrieveAddressFieldL(const CContactItemFieldSet& aFields, CArrayPtr<CParserParam>& aParams, CDesCArrayFlat& aDesArray, TFieldType aFieldType, TUid aMapping, const TDesC& aLabel, TInt aOption, TBool& aFound,TBool aExportPrivateFields,TBool aWithoutPref=ETrue) const;
	TBool LocateSpecificNameValueL(const CContactItemFieldSet& aFieldSet, TUid aSearchField, CDesCArray& aPropValueArray, CArrayPtr<CParserParam>& aPropParamArray, const TDesC& aLabelPrefix, TInt aOption, TBool aExportPrivateFields);
	static CParserPropertyValueDateTime* CreateDateTimePropertyL(const TTime& aDateTime, TVersitDateTime::TRelativeTime aRelativeTime);
	static CParserPropertyValueDate* CreateDatePropertyL(const TTime& aDateTime);
	void GetVCardOrgInfoL(const CContactItemFieldSet& aFields, TInt aOption, TBool aExportPrivateFields);
	void RemoveNewLineL(CDesCArray& aPropValueArray, const TPtrC& aFieldContents);
	TVCardVersion GetExportVersion()const;
	void GetVCardFormattedNameL(CContactItemFieldSet& aFields, TInt aOption, TBool aExportPrivateFields);
	TPBAPProperties AttributeFromMapping(TUid aMapping) const;
	TBool DefaultInternetParameterRequired(const CContentType& aContactType) const;
	void AddParamToArrayL(CArrayPtr<CParserParam>* aArrayOfParams, CParserParam* aParserParam, TInt32 aMappingUid, TInt32 aFieldTypeUid) const;
private: // UTILITY methods
	static TInt FindAddressFieldByMappingAndType(const CContactItemFieldSet& aFields, TFieldType aFieldType, TUid aMapping);

private:
	CParserVCard* iVCard;
	TInt64 iMachineUniqueId;
	Versit::TVersitCharSet iCharSet;
	TVCardVersion iVCardVersion;
	TInt64 iFilter;
	};


/**
 * Import and update converter
 */
class CVCardToContactsAppConverter : public CBase
	{
public:
	enum TUnknownPropertyBehaviour
		{
		EPreserveAllProperties,
		EDiscardNonXDashUnknownProperties,
		EDiscardAllUnknownProperties
		};

public:
	CContactItem* GetVCardAsContactItemLC(CParserVCard& aSourceVCard, TUnknownPropertyBehaviour aUnknownPropertyBehaviour, TInt aOption);
	void GetVCardUidStringL(CParserVCard& aSourceVCard, TDes& aUidString) const;
	TBool MergeVCardWithContactItemL(CContactItem& aContact,CParserVCard& aSourceVCard,TUnknownPropertyBehaviour aUnknownPropertyBehaviour,TInt aOption);

private:
	CContactItemField* GetVCardPropertyAsContactFieldLC(CParserProperty* aVCardProperty, TInt aOption,TBool& aUnsupportedProperty);
	static CContentType* MapVCardPropertyToContentAndStorageTypeL(const CParserProperty& aVCardProperty, TStorageType& aStorageType);
	//
	static void GetVCardModifiedTimeL(CParserVCard& aVCard,TTime& aLastModified);
	static TInt  GetVCardPropertyTTNumber(CParserProperty* aVCardProperty);
	static void DeleteField(CContactItem& aContact, const CContactItemFieldSet& aFieldSet, TFieldType aFieldType, TUid aMapping);

	static void GetContactNameL(CParserVCard& aVCard,CDesCArray* aName,TInt aOption,CDesCArray* aLabels);
	static TBool GetSpecifiedAddressL(CArrayPtr<CParserProperty>& aProperties, TInt aOption, const TDesC8& aParamMustMatch, const TDesC8& aParamMustNotMatch1, const TDesC8& aParamMustNotMatch2, CDesCArray& aAddressRepository, CDesCArray& aAddressLabelRepository);

	void MergeNameFieldsL(CContactItem& aContact, CVCardItemAndLabel& aNames, TInt aOption, TBool aTreatAsPrn = EFalse);
	void MergeSpecifiedNameFieldL(CContactItem& aContact, TFieldType aFieldType, CVCardItemAndLabel& aNames, TInt aOption, TInt aNameIndex);
	void MergeAddressFieldsL(CContactItem& aContact, const CVCardAddress& aAddress, TInt aOption);
	void MergeSpecifiedAddressFieldL(CContactItem& aContact, const CVCardAddress& aAddresses, const TUid& aFieldUid, const TUid& aMappingUid, TInt aNameIndex, TInt aOption);


private: // UTILITY methods
	TBool TextArrayContainsImportableData(const CDesCArray& aArray) const;
	static void RemoveWhitespaceFromCompositePropertyL(CDesCArray& aArray);
    static TFieldType MapVCardPhotoTypeToFieldType(TPtrC8 aBitmapStringPtr);
	inline void SetImportType(TCntVCardImportType aType) { iImportType = aType; }
	inline TCntVCardImportType ImportType() const { return iImportType; }
	HBufC* EncodeL(const TDesC& aText, TBool aTextTobeTruncated) const;
	TBool PropertyTobeTruncated(const TPtrC8& aFieldName) const;
    static void GetBitMapFormat(const CParserProperty& aVCardProperty, TFieldType& bitMapFormat);
    void AdjustForPrefRule(CContactItem& aContactItem, TFieldType aFieldType, TUid aMapping);

private: // NAME handling
	static void DeleteNameFields(CContactItem& aContact);
	static CVCardItemAndLabel* GetContactNameLC(CParserVCard& aVCard, TInt aOption);
	static CVCardItemAndLabel* GetContactNamePrnLC(CParserVCard& aVCard, TInt aOption);
	void SetNameFieldsL(const CVCardItemAndLabel& aNames, CContactItem& aContact, TInt aOption, TBool aTreatAsPronunciation = EFalse) const;
	void SetNameFieldL(const CVCardItemAndLabel& aNames, CContactItem& aContact, TInt aOption, TInt aIndex, TFieldType aFieldType, TInt& aInsertPos) const;
	static CVCardItemAndLabel* MakeNamesFromItemsL(const CDesCArray& aItems, TInt aOption, const CParserProperty* aProperty );

private: // ADDRESS handling
	static void DeleteAddressFields(CContactItem& aContact, TFieldType aFieldType);
	static void GetAddressesL(CParserVCard& aVCard, TInt aOption, RPointerArray<CVCardAddress>& aAddresses);
	static void GetHomeAndWorkAddressL(CParserVCard& aVCard, CDesCArray* aAddressHome, CDesCArray* aAddressWork, TInt aOption, CDesCArray* aAddressHomeLabels, CDesCArray* aAddressWorkLabels);
	void SetAddressFieldsL(const CVCardAddress& aAddress, CContactItem& aContact, TInt aOption) const;
	void SetAddressFieldL(const CVCardAddress& aAddress,
								 CContactItem& aContact,
								 TInt aOption,
								 TInt aIndex,
								 TFieldType aFieldType,
								 TInt& aInsertPos,
								 TUid aMapping
								 ) const;

	static CVCardAddress* GetSpecifiedAddressLC(const CArrayPtr<CParserProperty>& aProperties,
									  TInt aOption,
									  const TDesC8& aParamMustMatch,
									  const TDesC8& aParamMustNotMatch1,
									  const TDesC8& aParamMustNotMatch2,
									  TUid aMapping
									  );
									  
private: // Organization handling
TInt GetVCardPropertyAsArrayOfValuesL(const CParserVCard& aVCard, const TDesC8& aToken, CDesCArray& aItems);
void SetOrgDetailsL(CContactItem& aContact,  CDesCArray& aItems, const TInt aOption);
void SetSpecificFieldL(CContactItem& aContact,  CDesCArray& aItems, const TUid& aFieldType,const TUid& aMapping, TInt aOption, TInt aStartIndex, TInt aEndIndex);
void MergeOrgDetailsL(CContactItem& aContact,  CDesCArray& aItems, TInt aOption);
void MergeSpecificFieldL(CContactItem& aContact,  CDesCArray& aItems, const TFieldType& aFieldType, const TUid& aMapping, TInt aOption, TInt aStartIndex, TInt aEndIndex);

private: // Class handling
TInt GetSingleInstanceL(const CParserVCard& aVCard, const TDesC8& aToken, TDes& aClass);
void SetSingleInstanceL(CContactItem& aContact, const TDes& aValue,const TFieldType& aFieldType, const TUid& aMapping, TInt aOption);
void MergeSingleInstanceL(CContactItem& aContact, const TDes& aValue,const TFieldType& aFieldType, const TUid& aMapping, TInt aOption);

private: // Parameter handling
	static	TBool IsParameterValuePresent(CArrayPtr<CParserParam>* aParamArray, const TDesC8& aParamName, const TDesC8& aParamValue);

private:
	TUnknownPropertyBehaviour iUnknownPropertyBehaviour;
	TCntVCardImportType iImportType;
	};


/**
 * Generic base class representing a collection of items (e.g. names sub-fields) and their
 * associated labels
 */
class CVCardItemAndLabel : public CBase
	{
public:
	static CVCardItemAndLabel* NewLC();
	~CVCardItemAndLabel();

protected:
	CVCardItemAndLabel();
	void ConstructL();

public:
	void AddItemL(const TDesC& aItem);
	void AddLabelL(const TDesC& aItem);
	//
	TInt ItemCount() const;
	TInt LabelCount() const;
	//
	TPtrC Item(TInt aIndex) const;
	TPtrC Label(TInt aIndex) const;
	//
	TInt FindLabel(const TDesC& aName, TInt& aPosition) const;

public:
	static void CleanUpResetDestroyAndCloseArray(TAny* aArray);

private:
	CDesCArray* iItems;
	CDesCArray* iLabels;
	};


/**
 * Class used to hold address sub-fields and their associated labels.
 */
class CVCardAddress : public CVCardItemAndLabel
	{
public:
	static CVCardAddress* NewLC(TUid aMapping);

private:
	CVCardAddress(TUid aMapping);

public:
	inline TUid Mapping() const { return iMapping; }

private:
	TUid iMapping;
	};

/** Panic enumeration */
enum TCntVCardPanic
	{
	ECntVPanicAgentNotNull,
	ECntVPanicBadParamName,
	ECntVPanicInvalidImportType,
	};

GLREF_C void Panic(TCntVCardPanic aPanic);
GLREF_C void CleanUpResetAndDestroy(TAny *aArray);

#endif