summaryrefslogtreecommitdiff
path: root/plugins/UserInfoEx/src/ex_import/classExImContactXML.cpp
blob: de3135c5b4956d6eb7899aae0eeac38bf058e210 (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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
/*
UserinfoEx plugin for Miranda IM

Copyright:
© 2006-2010 DeathAxe, Yasnovidyashii, Merlin, K. Romanov, Kreol

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#include "../stdafx.h"

/***********************************************************************************************************
 * common stuff
 ***********************************************************************************************************/

/**
* name:	SortProc
* desc:	used for bsearch in CExImContactXML::IsContactInfo
* param:	item1	- item to compare
*			item2	- item to compare
* return:	the difference
**/

static int SortProc(const LPDWORD item1, const LPDWORD item2)
{
	return *item1 - *item2;
}

/**
* name:	CExImContactXML
* class:	CExImContactXML
* desc:	the constructor for the contact class
* param:	pXmlFile	- the owning xml file
* return:	nothing
**/

CExImContactXML::CExImContactXML(CFileXml *pXmlFile)
	: CExImContactBase()
{
	_xmlNode = NULL;
	_pXmlFile = pXmlFile;
	_hEvent = NULL;
}

/**
* name:	IsContactInfo
* class:	CExImContactXML
* desc:	this function compares the given setting key to the list of known contact
*			information keys
* param:	pszKey	- the settings key to check
* return:	TRUE if pszKey is a valid contact information
**/

BYTE CExImContactXML::IsContactInfo(LPCSTR pszKey)
{
	// This is a sorted list of all hashvalues of the contact information.
	// This is the same as the szCiKey[] array below but sorted
	const DWORD dwCiHash[] = {
		0x6576F145,0x65780A70,0x6719120C,0x6776F145,0x67780A70,0x6EDB33D7,0x6F0466B5,
		0x739B6915,0x73B11E48,0x760D8AD5,0x786A70D0,0x8813C350,0x88641AF8,0x8ED5652D,
		0x96D64541,0x97768A14,0x9B786F9C,0x9B7889F9,0x9C26E6ED,0xA6675748,0xA813C350,
		0xA8641AF8,0xAC408FCC,0xAC40AFCC,0xAC40CFCC,0xAEC6EA4C,0xB813C350,0xB8641AF8,
		0xC5227954,0xCC68DE0E,0xCCD62E70,0xCCFBAAF4,0xCD715E13,0xD36182CF,0xD361C2CF,
		0xD361E2CF,0xD42638DE,0xD4263956,0xD426395E,0xD453466E,0xD778D233,0xDB59D87A,
		0xE406F60E,0xE406FA0E,0xE406FA4E,0xECF7E910,0xEF660441,0x00331041,0x0039AB3A,
		0x003D88A6,0x07ABA803,0x113D8227,0x113DC227,0x113DE227,0x2288784F,0x238643D6,
		0x2671C03E,0x275F720B,0x2EBDC0D6,0x3075C8C5,0x32674C9F,0x33EEAE73,0x40239C1C,
		0x44DB75D0,0x44FA69D0,0x4C76989B,0x4FF38979,0x544B2F44,0x55AFAF8C,0x567A6BC5,
		0x5A96C47F,0x6376F145,0x63780A70
	};
	if (pszKey && *pszKey) {
		char buf[MAXSETTING];
		// convert to hash and make bsearch as it is much faster then working with strings
		const DWORD dwHash = hashSetting(_strlwr(mir_strncpy(buf, pszKey, _countof(buf))));
		return bsearch(&dwHash, dwCiHash, _countof(dwCiHash), sizeof(dwCiHash[0]), (int (*)(const void*, const void*))SortProc) != NULL;
	}
	return FALSE;
}

/***********************************************************************************************************
 * exporting stuff
 ***********************************************************************************************************/

/**
* name:	CreateXmlNode
* class:	CExImContactXML
* desc:	creates a new TiXmlElement representing the contact
*			whose information are stored in this class
* param:	none
* return:	pointer to the newly created TiXmlElement
**/

TiXmlElement* CExImContactXML::CreateXmlElement()
{
	if (_hContact) {
		if (_pszProto) {
			_xmlNode = new TiXmlElement(XKEY_CONTACT);

			if (_xmlNode) {
				LPSTR pszUID = uid2String(TRUE);
				_xmlNode->SetAttribute("ampro", _pszAMPro);
				_xmlNode->SetAttribute("proto", _pszProto);

				if (_pszDisp)  _xmlNode->SetAttribute("disp", _pszDisp);
				if (_pszNick)  _xmlNode->SetAttribute("nick", _pszNick);
				if (_pszGroup) _xmlNode->SetAttribute("group", _pszGroup);

				if (pszUID) {

					if (_pszUIDKey) {
						_xmlNode->SetAttribute("uidk", _pszUIDKey);
						_xmlNode->SetAttribute("uidv", pszUID);
					}
					else {
						_xmlNode->SetAttribute("uidk", "#NV");
						_xmlNode->SetAttribute("uidv", "UNLOADED");
					}
					mir_free(pszUID);
				}
			}
		}
		else _xmlNode = NULL;
	}
	else _xmlNode = new TiXmlElement(XKEY_OWNER);

	return _xmlNode;
}

/**
* name:	ExportContact
* class:	CExImContactXML
* desc:	exports a contact
* param:	none
* return:	ERROR_OK on success or any other on failure
**/

int CExImContactXML::ExportContact(DB::CEnumList* pModules)
{
	if (_pXmlFile->_wExport & EXPORT_DATA) {
		if (pModules) {
			int i;
			LPSTR p;

			for (i = 0; i < pModules->getCount(); i++) {
				p = (*pModules)[i];
				ExportModule(p);
			}
		}
		else {
			ExportModule(USERINFO);
			ExportModule(MOD_MBIRTHDAY);
		}
	}

	// export contact's events
	if (_pXmlFile->_wExport & EXPORT_HISTORY)
		ExportEvents();

	return ERROR_OK;
}

/**
* name:	ExportSubContact
* class:	CExImContactXML
* desc:	exports a meta sub contact
* param:	none
* return:	ERROR_OK on success or any other on failure
**/

int CExImContactXML::ExportSubContact(CExImContactXML *vMetaContact, DB::CEnumList* pModules)
{
	// create xmlNode
	if (!CreateXmlElement()) 
		return ERROR_INVALID_CONTACT;

	if (ExportContact(pModules) == ERROR_OK) 
		if (!_xmlNode->NoChildren() && vMetaContact->_xmlNode->LinkEndChild(_xmlNode)) 
			return ERROR_OK;

	delete _xmlNode;
	return ERROR_NOT_ADDED;
}

/**
* name:	Export
* class:	CExImContactXML
* desc:	exports a contact
* param:	xmlfile		- handle to the open file to write the contact to
*			pModules	- list of modules to export for each contact
* return:	ERROR_OK on success or any other on failure
**/

int CExImContactXML::Export(FILE *xmlfile, DB::CEnumList* pModules)
{
	if (!xmlfile) 
		return ERROR_INVALID_PARAMS;

	if (_hContact == INVALID_CONTACT_ID)
		return ERROR_INVALID_CONTACT;

	if (!CreateXmlElement()) 
		return ERROR_INVALID_CONTACT;

	// export meta
	if (isMeta()) {
		CExImContactXML vContact(_pXmlFile);

		const int cnt = db_mc_getSubCount(_hContact);
		const int def = db_mc_getDefaultNum(_hContact);
		MCONTACT hSubContact = db_mc_getSub(_hContact, def);

		// export default subcontact
		if (hSubContact && vContact.fromDB(hSubContact))
			vContact.ExportSubContact(this, pModules);

		for (int i = 0; i < cnt; i++) {
			if (i != def) {
				hSubContact = db_mc_getSub(_hContact, i);
				if (hSubContact && vContact.fromDB(hSubContact))
					vContact.ExportSubContact(this, pModules);
			}
		}
	}
	ExportContact(pModules);

	// add xContact to document
	if (_xmlNode->NoChildren()) {
		delete _xmlNode;
		_xmlNode = NULL;
		return ERROR_NOT_ADDED;
	}
	_xmlNode->Print(xmlfile, 1);
	fputc('\n', xmlfile);

	delete _xmlNode;
	_xmlNode = NULL;

	return ERROR_OK;
}

/**
* name:	ExportModule
* class:	CExImContactXML
* desc:	enumerates all settings of a database module and adds them to the xml tree
* params:	pszModule	- the module which is to export
* return:	ERROR_OK on success or any other on failure
**/

int CExImContactXML::ExportModule(LPCSTR pszModule)
{
	DB::CEnumList	Settings;
	if (!pszModule || !*pszModule)
		return ERROR_INVALID_PARAMS;

	if (!Settings.EnumSettings(_hContact, pszModule)) {
		TiXmlElement *xmod = new TiXmlElement(XKEY_MOD);
		if (!xmod)
			return ERROR_MEMORY_ALLOC;

		xmod->SetAttribute("key", pszModule);
		for (int i = 0; i < Settings.getCount(); i++)
			ExportSetting(xmod, pszModule, Settings[i]);

		if (!xmod->NoChildren() && _xmlNode->LinkEndChild(xmod))
			return ERROR_OK;

		delete xmod;
	}

	return ERROR_EMPTY_MODULE;
}

/**
* name:	ExportSetting
* desc:	read a setting from database and add an xmlelement to contact node
* params:	xmlModule	- xml node to add the setting to
*			hContact	- handle of the contact whose event chain is to export
*			pszModule	- the module which is to export
*			pszSetting	- the setting which is to export
* return:	pointer to the added element
**/

int CExImContactXML::ExportSetting(TiXmlElement *xmlModule, LPCSTR pszModule, LPCSTR pszSetting)
{
	TiXmlElement *xmlEntry = NULL;
	TiXmlText    *xmlValue = NULL;
	CHAR          buf[32];
	LPSTR         str = NULL;

	DBVARIANT dbv;
	if (DB::Setting::GetAsIs(_hContact, pszModule, pszSetting, &dbv))
		return ERROR_INVALID_VALUE;

	switch (dbv.type) {
	case DBVT_BYTE:		//'b' bVal and cVal are valid
		buf[0] = 'b';
		_ultoa(dbv.bVal, buf + 1, 10);
		xmlValue = new TiXmlText(buf);
		break;
	case DBVT_WORD:		//'w' wVal and sVal are valid
		buf[0] = 'w';
		_ultoa(dbv.wVal, buf + 1, 10);
		xmlValue = new TiXmlText(buf);
		break;
	case DBVT_DWORD:	//'d' dVal and lVal are valid
		buf[0] = 'd';
		_ultoa(dbv.dVal, buf + 1, 10);
		xmlValue = new TiXmlText(buf);
		break;
	case DBVT_ASCIIZ:	//'s' pszVal is valid
		if (mir_IsEmptyA(dbv.pszVal)) break;
		DB::Variant::ConvertString(&dbv, DBVT_UTF8);
		if (str = (LPSTR)mir_alloc(mir_strlen(dbv.pszVal) + 2)) {
			str[0] = 's';
			mir_strcpy(&str[1], dbv.pszVal);
			xmlValue = new TiXmlText(str);
			mir_free(str);
		}
		break;
	case DBVT_UTF8:		//'u' pszVal is valid
		if (mir_IsEmptyA(dbv.pszVal)) break;
		if (str = (LPSTR)mir_alloc(mir_strlen(dbv.pszVal) + 2)) {
			str[0] = 'u';
			mir_strcpy(&str[1], dbv.pszVal);
			xmlValue = new TiXmlText(str);
			mir_free(str);
		}
		break;
	case DBVT_WCHAR:	//'u' pwszVal is valid
		if (mir_IsEmptyW(dbv.pwszVal)) break;
		DB::Variant::ConvertString(&dbv, DBVT_UTF8);
		if (str = (LPSTR)mir_alloc(mir_strlen(dbv.pszVal) + 2)) {
			str[0] = 'u';
			mir_strcpy(&str[1], dbv.pszVal);
			xmlValue = new TiXmlText(str);
			mir_free(str);
		}
		break;
	case DBVT_BLOB:		//'n' cpbVal and pbVal are valid
		{
			// new buffer for base64 encoded data
			INT_PTR baselen = mir_base64_encode_bufsize(dbv.cpbVal);
			str = (LPSTR)mir_alloc(baselen + 6);
			assert(str != NULL);
			// encode data
			if ( mir_base64_encodebuf(dbv.pbVal, dbv.cpbVal, str+1, baselen)) {
				str[baselen+1] = 0;
				str[0] = 'n';
				xmlValue = new TiXmlText(str);
			}
			mir_free(str);
		}
		break;

	case DBVT_DELETED:	//this setting just got deleted, no other values are valid
		break;

	default:
		; // nothing
	}
	db_free(&dbv);
	if (xmlValue) {
		xmlEntry = new TiXmlElement(XKEY_SET);
		if (xmlEntry) {
			xmlEntry->SetAttribute("key", pszSetting);
			if (xmlEntry->LinkEndChild(xmlValue) && xmlModule->LinkEndChild(xmlEntry))
				return ERROR_OK;
			delete xmlEntry;
		}
		delete xmlValue;
	}
	return ERROR_MEMORY_ALLOC;
}

/**
* name:	ExportEvents
* desc:	adds the event chain for a given contact to the xml tree
* params:	xContact	- the xml node to add the events as childs to
*			hContact	- handle of the contact whose event chain is to export
* return:	TRUE on success, FALSE otherwise
**/

BYTE CExImContactXML::ExportEvents()
{
	int dwNumEvents = db_event_count(_hContact);
	if (dwNumEvents == 0)
		return FALSE;

	int dwNumEventsAdded = 0;

	// read out all events for the current contact
	for (MEVENT hDbEvent = db_event_first(_hContact); hDbEvent != NULL; hDbEvent = db_event_next(_hContact, hDbEvent)) {
		DBEVENTINFO dbei = {};
		if (DB::Event::GetInfoWithData(hDbEvent, &dbei))
			continue;

		// encode data
		LPSTR pBase64Data = mir_base64_encode(dbei.pBlob, dbei.cbBlob);
		if (pBase64Data) {
			TiXmlElement *xmlEvent = new TiXmlElement("evt");
			if (xmlEvent) {
				xmlEvent->SetAttribute("type", dbei.eventType);
				xmlEvent->SetAttribute("time", dbei.timestamp);
				xmlEvent->SetAttribute("flag", dbei.flags);

				TiXmlText *xmlText = new TiXmlText(pBase64Data);
				xmlEvent->LinkEndChild(xmlText);

				// find module
				TiXmlNode *xmlModule;
				for (xmlModule = _xmlNode->FirstChild(); xmlModule != NULL; xmlModule = xmlModule->NextSibling())
					if (!mir_strcmpi(((TiXmlElement*)xmlModule)->Attribute("key"), dbei.szModule))
						break;

				// create new module
				if (!xmlModule) {
					xmlModule = _xmlNode->InsertEndChild(TiXmlElement(XKEY_MOD));
					if (!xmlModule)
						break;
					((TiXmlElement*)xmlModule)->SetAttribute("key", dbei.szModule);
				}

				xmlModule->LinkEndChild(xmlEvent);
				dwNumEventsAdded++;
			}
		}
		MIR_FREE(dbei.pBlob);
	}

	return dwNumEventsAdded == dwNumEvents;
}

/***********************************************************************************************************
 * importing stuff
 ***********************************************************************************************************/

/**
* name:	CountKeys
* desc:	Counts the number of events and settings stored for a contact
* params:	xmlContact	- the contact, who is the owner of the keys to count
* return:	nothing
**/

void CExImContactXML::CountKeys(DWORD &numSettings, DWORD &numEvents)
{
	numSettings = numEvents = 0;

	for (TiXmlNode *xmod = _xmlNode->FirstChild();
		xmod != NULL; 
		xmod = xmod->NextSibling(XKEY_MOD)) {
		for (TiXmlNode *xkey = xmod->FirstChild();
			xkey != NULL;
			xkey = xkey->NextSibling()) {
			if (!mir_strcmpi(xkey->Value(), XKEY_SET))
				numSettings++;
			else
				numEvents++;
		}
	}
}

/**
* name:	LoadXmlElemnt
* class:	CExImContactXML
* desc:	get contact information from XML-file
* param:	xContact	- TiXmlElement representing a contact
* return:	ERROR_OK if successful or any other error number otherwise
**/

int CExImContactXML::LoadXmlElemnt(TiXmlElement *xContact)
{
	if (xContact == NULL)
		return ERROR_INVALID_PARAMS;

	// delete last contact
	db_free(&_dbvUID);
	_hContact = INVALID_CONTACT_ID;

	_xmlNode = xContact;
	MIR_FREE(_pszAMPro); ampro(xContact->Attribute("ampro"));
	MIR_FREE(_pszNick);  nick (xContact->Attribute("nick"));
	MIR_FREE(_pszDisp);  disp (xContact->Attribute("disp"));
	MIR_FREE(_pszGroup); group(xContact->Attribute("group"));
	MIR_FREE(_pszProto);
	MIR_FREE(_pszProtoOld);
	MIR_FREE(_pszUIDKey);

	// is contact a metacontact
	if (_pszAMPro && !mir_strcmp(_pszAMPro, META_PROTO)) {
		TiXmlElement *xSub;
		proto(META_PROTO);

		// meta contact must be uniquelly identified by its subcontacts
		// the metaID may change during an export or import call
		for(xSub  = xContact->FirstChildElement(XKEY_CONTACT); xSub != NULL; xSub  = xSub->NextSiblingElement(XKEY_CONTACT)) {
			CExImContactXML vSub(_pXmlFile);
			if (vSub = xSub) {
				// identify metacontact by the first valid subcontact in xmlfile
				if (_hContact == INVALID_CONTACT_ID && vSub.handle() != INVALID_CONTACT_ID) {
					MCONTACT hMeta = db_mc_getMeta(vSub.handle());
					if (hMeta != NULL) {
						_hContact = hMeta;
						break;
					}
				}
			}
		}
		// if no handle was found, this is a new meta contact
		_isNewContact = _hContact == INVALID_CONTACT_ID;
	}
	// entry is a default contact
	else {
		proto(xContact->Attribute("proto"));
		uidk (xContact->Attribute("uidk"));
		if (!_pszProto) {
			// check if this is the owner contact
			if (mir_strcmpi(xContact->Value(), XKEY_OWNER))
				return ERROR_INVALID_PARAMS;
			_hContact = NULL;
			_xmlNode  = xContact;
			return ERROR_OK;
		}

		if (_pszUIDKey && mir_strcmp("#NV", _pszUIDKey) != 0) {
			LPCSTR pUID = xContact->Attribute("uidv");

			if (pUID != NULL) {
				unsigned valLen;
				PBYTE	pbVal = NULL;

				switch (*(pUID++)) {
				case 'b':
					uid((BYTE)atoi(pUID));
					break;
				case 'w':
					uid((WORD)atoi(pUID));
					break;
				case 'd':
					uid((DWORD)_atoi64(pUID));
					break;
				case 's':
					// utf8 -> asci
					uida(pUID);
					break;
				case 'u':
					uidu(pUID);
					break;
				case 'n':
					pbVal = (PBYTE)mir_base64_decode(pUID, &valLen);
					if (pbVal != NULL)
						uidn(pbVal, valLen);
					break;
				default:
					uidu((LPCSTR)NULL);
					break;
				}
			}
		}
		// finally try to find contact in contact list
		findHandle();
	}
	return ERROR_OK;
}

/**
* name:	ImportContact
* class:	CExImContactXML
* desc:	create the contact if neccessary and copy
*			all information from the xmlNode to database
* param:	none
* return:	ERROR_OK on success or any other error number otherwise
**/

int CExImContactXML::ImportContact()
{
	// create the contact if not yet exists
	if (toDB() != INVALID_CONTACT_ID) {
		_hEvent = NULL;

		// count settings and events and init progress dialog
		DWORD numSettings, numEvents;
		CountKeys(numSettings, numEvents);
		_pXmlFile->_progress.SetSettingsCount(numSettings + numEvents);
		_pXmlFile->_numSettingsTodo += numSettings;
		_pXmlFile->_numEventsTodo += numEvents;

		// import all modules
		for (TiXmlNode *xmod = _xmlNode->FirstChild(); xmod != NULL; xmod = xmod->NextSibling(XKEY_MOD)) {
			// import module
			if (ImportModule(xmod) == ERROR_ABORTED) {
				// ask to delete new incomplete contact
				if (_isNewContact && _hContact != NULL) {
					int result = MsgBox(NULL, MB_YESNO|MB_ICONWARNING, 
						LPGENW("Question"), 
						LPGENW("Importing a new contact was aborted!"), 
						LPGENW("You aborted import of a new contact.\nSome information may be missing for this contact.\n\nDo you want to delete the incomplete contact?"));
					if (result == IDYES) {
						db_delete_contact(_hContact);
						_hContact = INVALID_CONTACT_ID;
					}
				}
				return ERROR_ABORTED;
			}
		}
		return ERROR_OK;
	}
	return ERROR_NOT_ADDED;
}

/**
* name:	ImportNormalContact
* class:	CExImContactXML
* desc:	create the contact if neccessary and copy
*			all information from the xmlNode to database.
*			Remove contact from a metacontact if it is a subcontact
* param:	none
* return:	ERROR_OK on success or any other error number otherwise
**/

int CExImContactXML::ImportNormalContact()
{
	int err = ImportContact();

	// remove contact from a metacontact
	if (err == ERROR_OK && db_mc_getMeta(_hContact))
		CallService(MS_MC_REMOVEFROMMETA, NULL, (LPARAM)_hContact);

	return err;
}

/**
* name:	Import
* class:	CExImContactXML
* desc:	create the contact if neccessary and copy
*			all information from the xmlNode to database.
*			Remove contact from a metacontact if it is a subcontact
* param:	TRUE = keepMetaSubContact
* return:	ERROR_OK on success or any other error number otherwise
**/

int CExImContactXML::Import(BYTE keepMetaSubContact)
{
	// xml contact contains subcontacts?
	TiXmlElement *xContact = _xmlNode->FirstChildElement("CONTACT");
	if (xContact) {
		// contact is a metacontact and metacontacts plugin is installed?
		if (isMeta()) {
			// create object for first sub contact
			CExImContactXML vContact(_pXmlFile);

			// the contact does not yet exist
			if (_isNewContact) {
				// import default contact as normal contact and convert to meta contact
				if (!(vContact = xContact))
					return ERROR_CONVERT_METACONTACT;

				// import as normal contact
				int result = vContact.ImportContact();
				if (result != ERROR_OK)
					return result;

				// convert default subcontact to metacontact
				_hContact = (MCONTACT)CallService(MS_MC_CONVERTTOMETA, (WPARAM)vContact.handle(), NULL);
				if (_hContact == NULL) {
					_hContact = INVALID_CONTACT_ID;
					return ERROR_CONVERT_METACONTACT;
				}

				_pXmlFile->_numContactsDone++;
				// do not load first meta contact twice
				xContact = xContact->NextSiblingElement("CONTACT");
			}
			// xml contact contains more than one subcontacts?
			if (xContact) {
				// load all subcontacts
				do {
					// update progressbar and abort if user clicked cancel
					int result = _pXmlFile->_progress.UpdateContact(L"Sub Contact: %s (%S)", 
						ptrW(mir_utf8decodeW(xContact->Attribute("nick"))), xContact->Attribute("proto"));
					
					// user clicked abort button
					if (!result) break;
					if (vContact = xContact) {
						if (vContact.ImportMetaSubContact(this) == ERROR_ABORTED)
							return ERROR_ABORTED;
						_pXmlFile->_numContactsDone++;
					}
				}
					while (xContact = xContact->NextSiblingElement("CONTACT"));
			}
			// load metacontact information (after subcontact for faster import)
			return ImportContact();
		}
		// import sub contacts as normal contacts
		return _pXmlFile->ImportContacts(_xmlNode);
	}

	// load contact information
	int result = ImportContact();
	if (result == ERROR_OK && !keepMetaSubContact)
		CallService(MS_MC_REMOVEFROMMETA, NULL, (LPARAM)_hContact);

	return result;
}

/**
* name:	ImportMetaSubContact
* class:	CExImContactXML
* desc:	create the contact if neccessary and copy
*			all information from the xmlNode to database.
*			Add this contact to an meta contact
* param:	pMetaContact	- the meta contact to add this one to
* return:	
**/

int CExImContactXML::ImportMetaSubContact(CExImContactXML * pMetaContact)
{
	// abort here if contact was not imported correctly
	int err = ImportContact();
	if (err != ERROR_OK)
		return err;

	// check if contact is subcontact of the desired meta contact
	if (db_mc_getMeta(_hContact) != pMetaContact->handle()) {
		// add contact to the metacontact (this service returns TRUE if successful)	
		err = CallService(MS_MC_ADDTOMETA, _hContact, (LPARAM)pMetaContact->handle());
		if (err == FALSE) {
			// ask to delete new contact
			if (_isNewContact && _hContact != NULL) {
				LPTSTR ptszNick = mir_utf8decodeW(_pszNick);
				LPTSTR ptszMetaNick = mir_utf8decodeW(pMetaContact->_pszNick);
				int result = MsgBox(NULL, MB_YESNO|MB_ICONWARNING, 
					LPGENW("Question"), 
					LPGENW("Importing a new meta subcontact failed!"), 
					LPGENW("The newly created meta subcontact '%s'\ncould not be added to metacontact '%s'!\n\nDo you want to delete this contact?"),
					ptszNick, ptszMetaNick);
				MIR_FREE(ptszNick);
				MIR_FREE(ptszMetaNick);
				if (result == IDYES) {
					db_delete_contact(_hContact);
					_hContact = INVALID_CONTACT_ID;
				}
			}
			return ERROR_ADDTO_METACONTACT;
		}
	}
	return ERROR_OK;
}

/**
* name:	ImportModule
* class:	CExImContactXML
* desc:	interprete an xmlnode as module and add the children to database.
* params:	hContact	- handle to the contact, who is the owner of the setting to import
*			xmlModule	- xmlnode representing the module
*			stat		- structure used to collect some statistics
* return:	ERROR_OK on success or one other element of ImportError to tell the type of failure
**/

int CExImContactXML::ImportModule(TiXmlNode* xmlModule)
{
	// check if parent is really a module
	if (!xmlModule || mir_strcmpi(xmlModule->Value(), XKEY_MOD))
		return ERROR_INVALID_SIGNATURE;

	// convert to element
	TiXmlElement *xMod = xmlModule->ToElement();
	if (!xMod)
		return ERROR_INVALID_PARAMS;

	// get module name
	LPCSTR pszModule = xMod->Attribute("key");
	if (!pszModule || !*pszModule)
		return ERROR_INVALID_PARAMS;

	// ignore Modul 'Protocol' as it would cause trouble
	if (!mir_strcmpi(pszModule, "Protocol"))
		return ERROR_OK;
	
	for (TiXmlElement *xKey = xmlModule->FirstChildElement(); xKey != NULL; xKey = xKey->NextSiblingElement()) {
		// import setting
		if (!mir_strcmpi(xKey->Value(), XKEY_SET)) {
			// check if the module to import is the contact's protocol module
			BYTE isProtoModule = !mir_strcmpi(pszModule, _pszProto)/* || DB::Module::IsMeta(pszModule)*/;
			BYTE isMetaModule = DB::Module::IsMeta(pszModule);

			// just ignore MetaModule on normal contact to avoid errors (only keys)
			if (!isProtoModule && isMetaModule)
				continue;

			// just ignore MetaModule on Meta to avoid errors (only import spetial keys)
			if (isProtoModule && isMetaModule) {
				if (!mir_strcmpi(xKey->Attribute("key"),"Nick") ||
					 !mir_strcmpi(xKey->Attribute("key"),"TzName") ||
					 !mir_strcmpi(xKey->Attribute("key"),"Timezone"))
				{
					if (ImportSetting(pszModule, xKey->ToElement()) == ERROR_OK)
						_pXmlFile->_numSettingsDone++;
				}
			}
			// just ignore some settings of protocol module to avoid errors (only keys)
			else if (isProtoModule && !isMetaModule) {
				if (!IsContactInfo(xKey->Attribute("key"))) {
					if (ImportSetting(pszModule, xKey->ToElement()) == ERROR_OK)
						_pXmlFile->_numSettingsDone++;
				}
			}
			// other module
			else if (ImportSetting(pszModule, xKey->ToElement()) == ERROR_OK) {
				_pXmlFile->_numSettingsDone++;
			}
			if (!_pXmlFile->_progress.UpdateSetting(LPGENW("Settings: %S"), pszModule))
				return ERROR_ABORTED;
		}
		// import event
		else if (!mir_strcmpi(xKey->Value(), XKEY_EVT)) {
			int error = ImportEvent(pszModule, xKey->ToElement());
			switch (error) {
			case ERROR_OK:
				_pXmlFile->_numEventsDone++;
				break;
			case ERROR_DUPLICATED:
				_pXmlFile->_numEventsDuplicated++;
				break;
			}
			if (!_pXmlFile->_progress.UpdateSetting(LPGENW("Events: %S"), pszModule))
				return ERROR_ABORTED;
		}
	} //*end for
	return ERROR_OK;
}

/**
* name:	ImportSetting
* class:	CExImContactXML
* desc:	interprete an setting representing xmlnode and write the corresponding setting to database.
* params:	xmlModule	- xmlnode representing the module to write the setting to in the database
*			xmlEntry	- xmlnode representing the setting to import
* return:	ERROR_OK on success or one other element of ImportError to tell the type of failure
**/

int CExImContactXML::ImportSetting(LPCSTR pszModule, TiXmlElement *xmlEntry)
{
	// validate parameter
	if (!xmlEntry || !pszModule || !*pszModule)
		return ERROR_INVALID_PARAMS;

	// validate value
	TiXmlText* xval = (TiXmlText*)xmlEntry->FirstChild();
	if (!xval || xval->Type() != TiXmlText::TEXT)
		return ERROR_INVALID_VALUE;

	LPCSTR value = xval->Value();
	DBVARIANT dbv = { 0 };
	
	// convert data
	unsigned baselen;

	switch (value[0]) {
	case 'b':			//'b' bVal and cVal are valid
		dbv.type = DBVT_BYTE;
		dbv.bVal = (BYTE)atoi(value + 1);
		break;
	case 'w':			//'w' wVal and sVal are valid
		dbv.type = DBVT_WORD;
		dbv.wVal = (WORD)atoi(value + 1);
		break;
	case 'd':			//'d' dVal and lVal are valid
		dbv.type = DBVT_DWORD;
		dbv.dVal = (DWORD)_atoi64(value + 1);
		break;
	case 's':			//'s' pszVal is valid
		dbv.type = DBVT_ASCIIZ;
		dbv.pszVal = (LPSTR)mir_utf8decodeA((LPSTR)(value + 1));
		break;
	case 'u':
		dbv.type = DBVT_UTF8;
		dbv.pszVal = (LPSTR)mir_strdup((LPSTR)(value + 1));
		break;
	case 'n':
		dbv.type = DBVT_BLOB;
		dbv.pbVal = (PBYTE)mir_base64_decode(value + 1, &baselen);
		if (dbv.pbVal != NULL)
			dbv.cpbVal = baselen;
		else {
			mir_free(dbv.pbVal);
			return ERROR_NOT_ADDED;
		}
		break;
	default:
		return ERROR_INVALID_TYPE;
	}

	// write value to db
	if (db_set(_hContact, pszModule, xmlEntry->Attribute("key"), &dbv)) {
		//if (cws.value.pbVal>0)
		mir_free(dbv.pbVal);
		if (dbv.type == DBVT_ASCIIZ || dbv.type == DBVT_UTF8) mir_free(dbv.pszVal);
		return ERROR_NOT_ADDED;
	}
	//if (dbv.pbVal>0)
	mir_free(dbv.pbVal);
	if (dbv.type == DBVT_ASCIIZ || dbv.type == DBVT_UTF8) mir_free(dbv.pszVal);
	return ERROR_OK;
}

/**
* name:	ImportEvent
* class:	CExImContactXML
* desc:	interprete an xmlnode and add the corresponding event to database.
* params:	hContact	- handle to the contact, who is the owner of the setting to import
*			xmlModule	- xmlnode representing the module to write the setting to in the database
*			xmlEvent	- xmlnode representing the event to import
* return:	ERROR_OK on success or one other element of ImportError to tell the type of failure
**/

int CExImContactXML::ImportEvent(LPCSTR pszModule, TiXmlElement *xmlEvent)
{
	// dont import events from metacontact
	if (isMeta())
		return ERROR_DUPLICATED;

	if (!xmlEvent || !pszModule || !*pszModule)
		return ERROR_INVALID_PARAMS;

	if (_stricmp(xmlEvent->Value(), "evt"))
		return ERROR_NOT_ADDED;

	// timestamp must be valid
	DBEVENTINFO	dbei = {};
	xmlEvent->Attribute("time", (LPINT)&dbei.timestamp);
	if (dbei.timestamp == 0)
		return ERROR_INVALID_TIMESTAMP;

	TiXmlText *xmlValue = (TiXmlText*)xmlEvent->FirstChild();
	if (!xmlValue || xmlValue->Type() != TiXmlText::TEXT)
		return ERROR_INVALID_VALUE;

	LPCSTR tmp = xmlValue->Value();
	if (!tmp || tmp[0] == 0)
		return ERROR_INVALID_VALUE;

	unsigned baselen;
	mir_ptr<BYTE> tmpVal((PBYTE)mir_base64_decode(tmp, &baselen));
	if (tmpVal != NULL) {
		// event owning module
		dbei.pBlob = tmpVal;
		dbei.cbBlob = baselen;
		dbei.szModule = (LPSTR)pszModule;

		xmlEvent->Attribute("type", (LPINT)&dbei.eventType);
		xmlEvent->Attribute("flag", (LPINT)&dbei.flags);
		if (dbei.flags == 0)
			dbei.flags = DBEF_READ;

		// search in new and existing contact for existing event to avoid duplicates
		if (DB::Event::Exists(_hContact, _hEvent, &dbei))
			return ERROR_DUPLICATED;

		if ((_hEvent = db_event_add(_hContact, &dbei)) != 0)
			return ERROR_OK;
	}

	return ERROR_NOT_ADDED;
}