summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
blob: 50ea3290594d0e83d522a481329dd9c2aeb71e70 (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
/*
 * XML Backend for the OPIE-Contact Database.
 *
 * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
 *
 * =====================================================================
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU Library General Public
 *      License as published by the Free Software Foundation; either
 *      version 2 of the License, or (at your option) any later version.
 * =====================================================================
 * ToDo: XML-Backend: Automatic reload if something was changed...
 *
 *
 * =====================================================================
 * Version: $Id$
 * =====================================================================
 * History:
 * $Log$
 * Revision 1.3  2002/10/14 16:21:54  eilers
 * Some minor interface updates
 *
 * Revision 1.2  2002/10/07 17:34:24  eilers
 * added OBackendFactory for advanced backend access
 *
 * Revision 1.1  2002/09/27 17:11:44  eilers
 * Added API for accessing the Contact-Database ! It is compiling, but
 * please do not expect that anything is working !
 * I will debug that stuff in the next time ..
 * Please read README_COMPILE for compiling !
 *
 *
 */

#ifndef _OContactAccessBackend_XML_
#define _OContactAccessBackend_XML_

#include <qasciidict.h>
#include <qdatetime.h>
#include <qfile.h>
#include <qfileinfo.h>
#include <qregexp.h>
#include <qarray.h>

#include <qpe/global.h>

#include <opie/xmltree.h>
#include "ocontactaccessbackend.h"
#include "ocontactaccess.h"

#include <stdlib.h>
#include <errno.h>

using namespace Opie;

/* the default xml implementation */
class OContactAccessBackend_XML : public OContactAccessBackend {
 public:
	OContactAccessBackend_XML ( QString appname, QString filename = 0l )
		{
			m_appName = appname;
			
			/* Set journalfile name ... */
			m_journalName = getenv("HOME");
			m_journalName +="/.abjournal" + appname;
			
			/* Expecting to access the default filename if nothing else is set */
			if ( filename.isEmpty() ){
				m_fileName = Global::applicationFileName( "addressbook","addressbook.xml" );
			} else
				m_fileName = filename;
			
			/* Load Database now */
			load ();
		}
	
	bool save() {
		QString strNewFile = m_fileName + ".new";
		QFile f( strNewFile );
		if ( !f.open( IO_WriteOnly|IO_Raw ) )
			return false;
		
		int total_written;
		QString out;
		out = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE Addressbook ><AddressBook>\n"
			" <Groups>\n"
			" </Groups>\n"
			" <Contacts>\n";
		//QValueList<Contact>::iterator it;
		QValueListConstIterator<OContact> it;
		for ( it = m_contactList.begin(); it != m_contactList.end(); ++it ) {
			out += "<Contact ";
			(*it).save( out );
			out += "/>\n";
			QCString cstr = out.utf8();
			total_written = f.writeBlock( cstr.data(), cstr.length() );
			if ( total_written != int(cstr.length()) ) {
				f.close();
				QFile::remove( strNewFile );
				return false;
			}
			out = "";
		}
		out += " </Contacts>\n</AddressBook>\n";
		
		QCString cstr = out.utf8();
		total_written = f.writeBlock( cstr.data(), cstr.length() );
		if ( total_written != int( cstr.length() ) ) {
			f.close();
			QFile::remove( strNewFile );
			return false;
		}
		f.close();
		
		// move the file over, I'm just going to use the system call
		// because, I don't feel like using QDir.
		if ( ::rename( strNewFile.latin1(), m_fileName.latin1() ) < 0 ) {
			qWarning( "problem renaming file %s to %s, errno: %d",
				  strNewFile.latin1(), m_journalName.latin1(), errno );
			// remove the tmp file...
			QFile::remove( strNewFile );
		}
		
		/* The journalfile should be removed now... */
		removeJournal();
		return true;
	}
	
	bool load () {
		m_contactList.clear();
		
		/* Load XML-File and journal if it exists */
		if ( !load ( m_fileName, false ) )
			return false;
		/* The returncode of the journalfile is ignored due to the
		 * fact that it does not exist when this class is instantiated !
		 * But there may such a file exist, if the application crashed.
		 * Therefore we try to load it to get the changes before the #
		 * crash happened...
		 */
		load (m_journalName, true);
		
		return true;
	}

	void clear () {
		m_contactList.clear();

	}
	
	bool wasChangedExternally()
		{
			QFileInfo fi( m_fileName );
			
			QDateTime lastmod = fi.lastModified ();
			
			return (lastmod != m_readtime);
		}
	
	QArray<int> allRecords() const {
		QArray<int> uid_list( m_contactList.count() );
		
		uint counter = 0; 
		QValueListConstIterator<OContact> it;
		for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
			uid_list[counter++] = (*it).uid();
		}
		
		return ( uid_list );
	}
	
	OContact find ( int uid ) const
		{
			bool found = false;
			OContact foundContact; //Create empty contact

			QValueListConstIterator<OContact> it;
			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
				if ((*it).uid() == uid){
					found = true;
					break;
				}
			}
			if ( found ){
				foundContact = *it;
			}
			
			return ( foundContact );
		}
	
	QArray<int> queryByExample ( const OContact &query, int settings ){
		
		QArray<int> m_currentQuery( m_contactList.count() );
		QValueListConstIterator<OContact> it;
		uint arraycounter = 0;
		
		for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
			/* Search all fields and compare them with query object. Store them into list
			 * if all fields matches.
			 */
			bool allcorrect = true;
			for ( int i = 0; i < Qtopia::rid; i++ ) {
				/* Just compare fields which are not empty in the query object */
				if ( !query.field(i).isEmpty() ){
					switch ( settings & ~OContactAccess::IgnoreCase ){
					case OContactAccess::RegExp:{
						QRegExp expr ( query.field(i),
							       !(settings & OContactAccess::IgnoreCase),
							       false );
						if ( expr.find ( (*it).field(i), 0 ) == -1 )
							allcorrect = false;
					}
						break;
					case OContactAccess::WildCards:{
						QRegExp expr ( query.field(i),
							       !(settings & OContactAccess::IgnoreCase),
							       true );
						if ( expr.find ( (*it).field(i), 0 ) == -1 )
							allcorrect = false;
					}
						break;
					case OContactAccess::ExactMatch:{
						if (settings & OContactAccess::IgnoreCase){
							if ( query.field(i).upper() !=
							     (*it).field(i).upper() )
								allcorrect = false;
						}else{
							if ( query.field(i) != (*it).field(i) )
								allcorrect = false;
						}
					}
						break;
					}
				}
			}
			if ( allcorrect ){
				m_currentQuery[arraycounter++] = (*it).uid();
			}
		}
			
		// Shrink to fit..
		m_currentQuery.resize(arraycounter);
	
		return m_currentQuery;
	}
	
	const uint querySettings()
		{
			return ( OContactAccess::WildCards
				 & OContactAccess::IgnoreCase
				 & OContactAccess::RegExp
				 & OContactAccess::ExactMatch );
		}
	
	bool hasQuerySettings (uint querySettings) const
		{
			/* OContactAccess::IgnoreCase may be added with one
			 * of the other settings, but never used alone.
			 * The other settings are just valid alone...
			 */
			switch ( querySettings & ~OContactAccess::IgnoreCase ){
			case OContactAccess::RegExp:
				return ( true );
			case OContactAccess::WildCards:
				return ( true );
			case OContactAccess::ExactMatch:
				return ( true );
			default:
				return ( false );
			}
		}
	
	bool add ( const OContact &newcontact )
		{
			//qWarning("odefaultbackend: ACTION::ADD");
			updateJournal (newcontact, OContact::ACTION_ADD);
			addContact_p( newcontact );
			return true;
		}
	
	bool replace ( const OContact &contact )
		{
			bool found = false;
			
			QValueListIterator<OContact> it;
			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
				if ( (*it).uid() == contact.uid() ){
					found = true;
					break;
				}
			}
			if (found) {
				updateJournal (contact, OContact::ACTION_REPLACE);
				m_contactList.remove (it);
				m_contactList.append (contact);
				return true;
			} else
				return false;
		}
	
	bool remove ( int uid )
		{
			bool found = false;
			QValueListIterator<OContact> it;
			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
				if ((*it).uid() == uid){
					found = true;
					break;
				}
			}
			if (found) {
				updateJournal ( *it, OContact::ACTION_REMOVE);
				m_contactList.remove (it);
				return true;
			} else
				return false;
		}
	
	bool reload(){
		/* Reload is the same as load in this implementation */
		return ( load() );
	}
	
 private:
	void addContact_p( const OContact &newcontact ){
		m_contactList.append (newcontact);
	}
	
	/* This function loads the xml-database and the journalfile */
	bool load( const QString filename, bool isJournal ) {
		
		/* We use the time of the last read to check if the file was
		 * changed externally.
		 */
		if ( !isJournal ){
			QFileInfo fi( filename );
			m_readtime = fi.lastModified ();
		}
		
		const int JOURNALACTION = Qtopia::Notes + 1;
		const int JOURNALROW = JOURNALACTION + 1;
		
		bool foundAction = false;
		OContact::journal_action action = OContact::ACTION_ADD;
		int journalKey = 0;
		QMap<int, QString> contactMap;
		QMap<QString, QString> customMap;
		QMap<QString, QString>::Iterator customIt;
		QAsciiDict<int> dict( 47 );
		
		dict.setAutoDelete( TRUE );
		dict.insert( "Uid", new int(Qtopia::AddressUid) );
		dict.insert( "Title", new int(Qtopia::Title) );
		dict.insert( "FirstName", new int(Qtopia::FirstName) );
		dict.insert( "MiddleName", new int(Qtopia::MiddleName) );
		dict.insert( "LastName", new int(Qtopia::LastName) );
		dict.insert( "Suffix", new int(Qtopia::Suffix) );
		dict.insert( "FileAs", new int(Qtopia::FileAs) );
		dict.insert( "Categories", new int(Qtopia::AddressCategory) );
		dict.insert( "DefaultEmail", new int(Qtopia::DefaultEmail) );
		dict.insert( "Emails", new int(Qtopia::Emails) );
		dict.insert( "HomeStreet", new int(Qtopia::HomeStreet) );
		dict.insert( "HomeCity", new int(Qtopia::HomeCity) );
		dict.insert( "HomeState", new int(Qtopia::HomeState) );
		dict.insert( "HomeZip", new int(Qtopia::HomeZip) );
		dict.insert( "HomeCountry", new int(Qtopia::HomeCountry) );
		dict.insert( "HomePhone", new int(Qtopia::HomePhone) );
		dict.insert( "HomeFax", new int(Qtopia::HomeFax) );
		dict.insert( "HomeMobile", new int(Qtopia::HomeMobile) );
		dict.insert( "HomeWebPage", new int(Qtopia::HomeWebPage) );
		dict.insert( "Company", new int(Qtopia::Company) );
		dict.insert( "BusinessStreet", new int(Qtopia::BusinessStreet) );
		dict.insert( "BusinessCity", new int(Qtopia::BusinessCity) );
		dict.insert( "BusinessState", new int(Qtopia::BusinessState) );
		dict.insert( "BusinessZip", new int(Qtopia::BusinessZip) );
		dict.insert( "BusinessCountry", new int(Qtopia::BusinessCountry) );
		dict.insert( "BusinessWebPage", new int(Qtopia::BusinessWebPage) );
		dict.insert( "JobTitle", new int(Qtopia::JobTitle) );
		dict.insert( "Department", new int(Qtopia::Department) );
		dict.insert( "Office", new int(Qtopia::Office) );
		dict.insert( "BusinessPhone", new int(Qtopia::BusinessPhone) );
		dict.insert( "BusinessFax", new int(Qtopia::BusinessFax) );
		dict.insert( "BusinessMobile", new int(Qtopia::BusinessMobile) );
		dict.insert( "BusinessPager", new int(Qtopia::BusinessPager) );
		dict.insert( "Profession", new int(Qtopia::Profession) );
		dict.insert( "Assistant", new int(Qtopia::Assistant) );
		dict.insert( "Manager", new int(Qtopia::Manager) );
		dict.insert( "Spouse", new int(Qtopia::Spouse) );
		dict.insert( "Children", new int(Qtopia::Children) );
		dict.insert( "Gender", new int(Qtopia::Gender) );
		dict.insert( "Birthday", new int(Qtopia::Birthday) );
		dict.insert( "Anniversary", new int(Qtopia::Anniversary) );
		dict.insert( "Nickname", new int(Qtopia::Nickname) );
		dict.insert( "Notes", new int(Qtopia::Notes) );
		dict.insert( "action", new int(JOURNALACTION) );
		dict.insert( "actionrow", new int(JOURNALROW) );
		
		//qWarning( "OContactDefaultBackEnd::loading %s", filename.latin1() );
		
		XMLElement *root = XMLElement::load( filename );
		if(root != 0l ){ // start parsing
			/* Parse all XML-Elements and put the data into the
			 * Contact-Class
			 */
			XMLElement *element = root->firstChild();
			//qWarning("OContactAccess::load tagName(): %s", root->tagName().latin1() );
			element = element->firstChild();
			
			/* Search Tag "Contacts" which is the parent of all Contacts */
			while( element && !isJournal ){
				if( element->tagName() != QString::fromLatin1("Contacts") ){
					//qWarning ("OContactDefBack::Searching for Tag \"Contacts\"! Found: %s",
					//	  element->tagName().latin1());
					element = element->nextChild();
				} else {
					element = element->firstChild();
					break;
				}
			}
			/* Parse all Contacts and ignore unknown tags */
			while( element ){
				if( element->tagName() != QString::fromLatin1("Contact") ){
					//qWarning ("OContactDefBack::Searching for Tag \"Contact\"! Found: %s",
					//	  element->tagName().latin1());
					element = element->nextChild();
					continue;
				}
				/* Found alement with tagname "contact", now parse and store all
				 * attributes contained
				 */
				//qWarning("OContactDefBack::load element tagName() : %s",
				//	 element->tagName().latin1() );
				QString dummy;
				foundAction = false;
				
				XMLElement::AttributeMap aMap = element->attributes();
				XMLElement::AttributeMap::Iterator it;
				contactMap.clear();
				customMap.clear();
				for( it = aMap.begin(); it != aMap.end(); ++it ){
					// qWarning ("Read Attribute: %s=%s", it.key().latin1(),it.data().latin1());
					
					int *find = dict[ it.key() ];
					/* Unknown attributes will be stored as "Custom" elements */
					if ( !find ) {
						qWarning("Attribute %s not known.", it.key().latin1());
						//contact.setCustomField(it.key(), it.data());
						customMap.insert( it.key(),  it.data() );
						continue;
					}
					
					/* Check if special conversion is needed and add attribute
					 * into Contact class
					 */
					switch( *find ) {
						/*
						  case Qtopia::AddressUid:
						  contact.setUid( it.data().toInt() );
						  break;
						  case Qtopia::AddressCategory:
						  contact.setCategories( Qtopia::Record::idsFromString( it.data( )));
						  break;
						*/
					case JOURNALACTION:
						action = OContact::journal_action(it.data().toInt());
						foundAction = true;
						qWarning ("ODefBack(journal)::ACTION found: %d", action);
						break;
					case JOURNALROW:
						journalKey = it.data().toInt();
						break;
					default: // no conversion needed add them to the map
						contactMap.insert( *find, it.data() );
						break;
					}
				}
				/* now generate the Contact contact */
				OContact contact( contactMap );
				
				for (customIt = customMap.begin(); customIt != customMap.end(); ++customIt ) {
					contact.setCustomField( customIt.key(),  customIt.data() );
				}
				
				if (foundAction){
					foundAction = false;
					switch ( action ) {
					case OContact::ACTION_ADD:
						addContact_p (contact);
						break;
					case OContact::ACTION_REMOVE:
						if ( !remove (contact.uid()) )
							qWarning ("ODefBack(journal)::Unable to remove uid: %d",
								  contact.uid() );
						break;
					case OContact::ACTION_REPLACE:
						if ( !replace ( contact ) )
							qWarning ("ODefBack(journal)::Unable to replace uid: %d",
								  contact.uid() );
						break;
					default:
						qWarning ("Unknown action: ignored !");
						break;
					}
				}else{
					/* Add contact to list */
					addContact_p (contact);
				}
				
				/* Move to next element */
				element = element->nextChild();
			}
		}else {
			qWarning("ODefBack::could not load");
		}
		delete root;
		qWarning("returning from loading" );
		return true;
	}
	
	
	void updateJournal( const OContact& cnt,
			    OContact::journal_action action ) {
		QFile f( m_journalName );
		bool created = !f.exists();
		if ( !f.open(IO_WriteOnly|IO_Append) )
			return;
		
		QString buf;
		QCString str;
		
		// if the file was created, we have to set the Tag "<CONTACTS>" to
		// get a XML-File which is readable by our parser.
		// This is just a cheat, but better than rewrite the parser.
		if ( created ){
			buf = "<Contacts>";
			QCString cstr = buf.utf8();
			f.writeBlock( cstr.data(), cstr.length() );
		}
		
		buf = "<Contact ";
		cnt.save( buf );
		buf += " action=\"" + QString::number( (int)action ) + "\" ";
		buf += "/>\n";
		QCString cstr = buf.utf8();
		f.writeBlock( cstr.data(), cstr.length() );
	}
	
	void removeJournal()
		{
			QFile f ( m_journalName );
			if ( f.exists() )
				f.remove();
		}
	
 protected:
	QString m_journalName;
	QString m_fileName;
	QString m_appName;
	QValueList<OContact> m_contactList;
	QDateTime m_readtime;
};

#endif