Improved query by example: Search by date is possible.. First step

for a today plugin for birthdays..

4 files changed, 226 insertions, 68 deletions

diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h
index 961968f..32b2dcb 100644
--- a/libopie/pim/ocontactaccess.h
+++ b/libopie/pim/ocontactaccess.h
@@ -1,150 +1,158 @@
 /*
  * Class to manage the Contacts.
  *
  * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
  * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org)
  *
  * =====================================================================
  *	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: Define enum for query settings
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.6  2003/01/02 14:27:12  eilers
+ * Improved query by example: Search by date is possible.. First step
+ * for a today plugin for birthdays..
+ *
  * Revision 1.5  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
  * Revision 1.4  2002/11/01 15:10:42  eilers
  * Added regExp-search in database for all fields in a contact.
  *
  * Revision 1.3  2002/10/16 10:52:40  eilers
  * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
  *
  * Revision 1.2  2002/10/14 16:21:54  eilers
  * Some minor interface updates
  *
  * 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 _OCONTACTACCESS_H
 #define _OCONTACTACCESS_H
 
 #include <qobject.h>
 
 #include <qpe/qcopenvelope_qws.h>
 
 #include <qvaluelist.h>
 #include <qfileinfo.h>
 
 #include "ocontact.h"
 #include "ocontactaccessbackend.h"
 #include "opimaccesstemplate.h"
 
 /** Class to access the contacts database.
  * This is just a frontend for the real database handling which is
  * done by the backend.
  * @see OPimAccessTemplate
  */
 class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 {
     Q_OBJECT
 
  public:
 	/** Create Database with contacts (addressbook).
 	 * @param appname Name of application which wants access to the database
 	 * (i.e. "todolist")
 	 * @param filename The name of the database file. If not set, the default one
 	 * is used.
 	 * @param backend Pointer to an alternative Backend. If not set, we will use
 	 * the default backend.
 	 * @param handlesync If <b>true</b> the database stores the current state
 	 * automatically if it receives the signals <i>flush()</i> and <i>reload()</i>
 	 * which are used before and after synchronisation. If the application wants
 	 * to react itself, it should be disabled by setting it to <b>false</b>
 	 * @see OContactAccessBackend
 	 */
 	OContactAccess (const QString appname, const QString filename = 0l,
                     OContactAccessBackend* backend = 0l, bool handlesync = true);
 	~OContactAccess ();
 
 	/** Constants for query.
 	 * Use this constants to set the query parameters.
 	 * Note: <i>query_IgnoreCase</i> just make sense with one of the other attributes !
 	 * @see queryByExample()
 	 */
 	enum QuerySettings {
 		WildCards  = 0x0001,
 		IgnoreCase = 0x0002,
 		RegExp     = 0x0004,
 		ExactMatch = 0x0008,
-		MatchOne   = 0x0010  // Only one Entry must match
+		MatchOne   = 0x0010, // Only one Entry must match
+		DateDiff   = 0x0020, // Find all entries from today until given date
+		DateYear   = 0x0040, // The year matches
+		DateMonth  = 0x0080, // The month matches
+		DateDay    = 0x0100, // The day matches
 	};
 
 	
 	ORecordList<OContact> matchRegexp(  const QRegExp &r )const;
 
 	/** Return all Contacts in a sorted manner.
 	 *  @param ascending true: Sorted in acending order.
 	 *  @param sortOrder Currently not implemented. Just defined to stay compatible to otodoaccess
 	 *  @param sortFilter Currently not implemented. Just defined to stay compatible to otodoaccess
 	 *  @param cat Currently not implemented. Just defined to stay compatible to otodoaccess
 	 */
 	List sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const;
 
 	/** Return all possible settings.
 	 *  @return All settings provided by the current backend
 	 * (i.e.: query_WildCards & query_IgnoreCase)
 	 */
 	const uint querySettings();
 
 	/** Check whether settings are correct.
 	 * @return <i>true</i> if the given settings are correct and possible.
 	 */
 	bool hasQuerySettings ( int querySettings ) const;
 
 	/**
 	 * if the resource was changed externally.
 	 * You should use the signal instead of polling possible changes !
 	 */
 	bool wasChangedExternally()const;
 
 
 	/** Save contacts database.
 	 * Save is more a "commit". After calling this function, all changes are public available.
 	 * @return true if successful
 	 */
 	bool save();
 
  signals:
 	/* Signal is emitted if the database was changed. Therefore
 	 * we may need to reload to stay consistent.
 	 * @param which Pointer to the database who created this event. This pointer
 	 * is useful if an application has to handle multiple databases at the same time.
 	 * @see reload()
 	 */
 	void signalChanged ( const OContactAccess *which );
 
 
  private:
 	// class OContactAccessPrivate;
 	// OContactAccessPrivate* d;
         OContactAccessBackend *m_backEnd;
         bool m_loading:1;
 
  private slots:
 	void copMessage( const QCString &msg, const QByteArray &data );
 
 
 };
 #endif
diff --git a/libopie/pim/ocontactaccessbackend_xml.h b/libopie/pim/ocontactaccessbackend_xml.h
index c765ff5..c6e6cbc 100644
--- a/libopie/pim/ocontactaccessbackend_xml.h
+++ b/libopie/pim/ocontactaccessbackend_xml.h
@@ -1,433 +1,504 @@
 /*
  * 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.10  2003/01/02 14:27:12  eilers
+ * Improved query by example: Search by date is possible.. First step
+ * for a today plugin for birthdays..
+ *
  * Revision 1.9  2002/12/08 12:48:57  eilers
  * Moved journal-enum from ocontact into i the xml-backend..
  *
  * Revision 1.8  2002/11/14 17:04:24  eilers
  * Sorting will now work if fullname is identical on some entries
  *
  * Revision 1.7  2002/11/13 15:02:46  eilers
  * Small Bug in sorted fixed
  *
  * Revision 1.6  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
  * Revision 1.5  2002/11/01 15:10:42  eilers
  * Added regExp-search in database for all fields in a contact.
  *
  * Revision 1.4  2002/10/16 10:52:40  eilers
  * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
  *
  * 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 <qmap.h>
+#include <qdatetime.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_changed( false )
 		{
 			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() {
 
 		if ( !m_changed )
 			return true;
 
 		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();
 
 		m_changed = false;
 		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();
 		m_changed = false;
 
 	}
 	
 	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.
 			 */
+			QDate* queryDate = 0l;
+			QDate* checkDate = 0l;
 			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;
+			for ( int i = 0; i < Qtopia::Groups; i++ ) {
+				// Birthday and anniversary are special nonstring fields and should
+				// be handled especially
+				switch ( i ){
+				case Qtopia::Birthday:
+					queryDate = new QDate( query.birthday() );
+					checkDate = new QDate( (*it).birthday() );
+				case Qtopia::Anniversary:
+					if ( queryDate == 0l ){
+						queryDate = new QDate( query.anniversary() );
+						checkDate = new QDate( (*it).anniversary() );
 					}
-						break;
-					case OContactAccess::ExactMatch:{
-						if (settings & OContactAccess::IgnoreCase){
-							if ( query.field(i).upper() !=
-							     (*it).field(i).upper() )
+					
+					if ( queryDate->isValid() ){
+						if ( settings & OContactAccess::DateYear ){
+							if ( queryDate->year() != checkDate->year() )
 								allcorrect = false;
-						}else{
-							if ( query.field(i) != (*it).field(i) )
+						} 
+						if ( settings & OContactAccess::DateMonth ){
+							if ( queryDate->month() != checkDate->month() )
 								allcorrect = false;
+						} 
+						if ( settings & OContactAccess::DateDay ){
+							if ( queryDate->day() != checkDate->day() )
+								allcorrect = false;
+						} 
+						if ( settings & OContactAccess::DateDiff ) {
+							QDate current = QDate::currentDate();
+							if ( current.daysTo( *queryDate ) > 0 ){
+								if ( !( ( *checkDate >= current ) && 
+									( *checkDate <= *queryDate ) ) )
+									allcorrect = false;
+							}
 						}
 					}
-						break;
+
+					delete queryDate;
+					queryDate = 0l;
+					delete checkDate;
+					checkDate = 0l;
+					break;
+				default:
+					/* Just compare fields which are not empty in the query object */
+					if ( !query.field(i).isEmpty() ){
+						switch ( settings & ~( OContactAccess::IgnoreCase
+								       | OContactAccess::DateDiff
+								       | OContactAccess::DateYear
+								       | OContactAccess::DateMonth
+								       | OContactAccess::DateDay
+								       | OContactAccess::MatchOne 
+								      ) ){
+
+						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;
 	}
 
 	QArray<int> matchRegexp(  const QRegExp &r ) const{
 		QArray<int> m_currentQuery( m_contactList.count() );
 		QValueListConstIterator<OContact> it;
 		uint arraycounter = 0;
 		
 		for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 			if ( (*it).match( r ) ){
 				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 );
+				 | OContactAccess::IgnoreCase
+				 | OContactAccess::RegExp
+				 | OContactAccess::ExactMatch 
+				 | OContactAccess::DateDiff
+				 | OContactAccess::DateYear
+				 | OContactAccess::DateMonth
+				 | OContactAccess::DateDay
+				);
 		}
 	
 	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...
+			/* OContactAccess::IgnoreCase, DateDiff, DateYear, DateMonth, DateDay 
+			 * may be added with any of the other settings. IgnoreCase should never used alone.
+			 * Wildcards, RegExp, ExactMatch should never used at the same time...
 			 */
-			switch ( querySettings & ~OContactAccess::IgnoreCase ){
+
+			if ( querySettings == OContactAccess::IgnoreCase ) 
+				return false;
+
+			switch ( querySettings & ~( OContactAccess::IgnoreCase
+						    | OContactAccess::DateDiff
+						    | OContactAccess::DateYear
+						    | OContactAccess::DateMonth
+						    | OContactAccess::DateDay
+						  ) 
+			       ){
 			case OContactAccess::RegExp:
 				return ( true );
 			case OContactAccess::WildCards:
 				return ( true );
 			case OContactAccess::ExactMatch:
 				return ( true );
 			default:
 				return ( false );
 			}
 		}
 	
 	// Currently only asc implemented.. 
 	QArray<int> sorted( bool asc,  int , int ,  int ) 
 		{
 			QMap<QString, int> nameToUid;
 			QStringList names;
 			QArray<int> m_currentQuery( m_contactList.count() );
 
 			// First fill map and StringList with all Names 
 			// Afterwards sort namelist and use map to fill array to return..
 			QValueListConstIterator<OContact> it;
 			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 				names.append( (*it).fileAs() + QString::number( (*it).uid() ) );
 				nameToUid.insert( (*it).fileAs() + QString::number( (*it).uid() ), (*it).uid() );
 			}
 			names.sort();
 
 			int i = 0;
 			if ( asc ){
 				for ( QStringList::Iterator it = names.begin(); it != names.end(); ++it )
 					m_currentQuery[i++] = nameToUid[ (*it) ];
 			}else{
 				for ( QStringList::Iterator it = names.end(); it != names.begin(); --it )
 					m_currentQuery[i++] = nameToUid[ (*it) ];
 			}
 			
 			return m_currentQuery;
 			
 		}
 	bool add ( const OContact &newcontact )
 		{
 			//qWarning("odefaultbackend: ACTION::ADD");
 			updateJournal (newcontact, ACTION_ADD);
 			addContact_p( newcontact );
 			
 			m_changed = true;
 
 			return true;
 		}
 	
 	bool replace ( const OContact &contact )
 		{
 			m_changed = true;
 
 			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, ACTION_REPLACE);
 				m_contactList.remove (it);
 				m_contactList.append (contact);
 				return true;
 			} else
 				return false;
 		}
 	
 	bool remove ( int uid )
 		{
 			m_changed = true;
 
 			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, 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:
 
 	enum journal_action { ACTION_ADD, ACTION_REMOVE, ACTION_REPLACE };
 
 	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;
 		journal_action action = 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 );
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
index c765ff5..c6e6cbc 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
@@ -1,433 +1,504 @@
 /*
  * 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.10  2003/01/02 14:27:12  eilers
+ * Improved query by example: Search by date is possible.. First step
+ * for a today plugin for birthdays..
+ *
  * Revision 1.9  2002/12/08 12:48:57  eilers
  * Moved journal-enum from ocontact into i the xml-backend..
  *
  * Revision 1.8  2002/11/14 17:04:24  eilers
  * Sorting will now work if fullname is identical on some entries
  *
  * Revision 1.7  2002/11/13 15:02:46  eilers
  * Small Bug in sorted fixed
  *
  * Revision 1.6  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
  * Revision 1.5  2002/11/01 15:10:42  eilers
  * Added regExp-search in database for all fields in a contact.
  *
  * Revision 1.4  2002/10/16 10:52:40  eilers
  * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
  *
  * 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 <qmap.h>
+#include <qdatetime.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_changed( false )
 		{
 			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() {
 
 		if ( !m_changed )
 			return true;
 
 		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();
 
 		m_changed = false;
 		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();
 		m_changed = false;
 
 	}
 	
 	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.
 			 */
+			QDate* queryDate = 0l;
+			QDate* checkDate = 0l;
 			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;
+			for ( int i = 0; i < Qtopia::Groups; i++ ) {
+				// Birthday and anniversary are special nonstring fields and should
+				// be handled especially
+				switch ( i ){
+				case Qtopia::Birthday:
+					queryDate = new QDate( query.birthday() );
+					checkDate = new QDate( (*it).birthday() );
+				case Qtopia::Anniversary:
+					if ( queryDate == 0l ){
+						queryDate = new QDate( query.anniversary() );
+						checkDate = new QDate( (*it).anniversary() );
 					}
-						break;
-					case OContactAccess::ExactMatch:{
-						if (settings & OContactAccess::IgnoreCase){
-							if ( query.field(i).upper() !=
-							     (*it).field(i).upper() )
+					
+					if ( queryDate->isValid() ){
+						if ( settings & OContactAccess::DateYear ){
+							if ( queryDate->year() != checkDate->year() )
 								allcorrect = false;
-						}else{
-							if ( query.field(i) != (*it).field(i) )
+						} 
+						if ( settings & OContactAccess::DateMonth ){
+							if ( queryDate->month() != checkDate->month() )
 								allcorrect = false;
+						} 
+						if ( settings & OContactAccess::DateDay ){
+							if ( queryDate->day() != checkDate->day() )
+								allcorrect = false;
+						} 
+						if ( settings & OContactAccess::DateDiff ) {
+							QDate current = QDate::currentDate();
+							if ( current.daysTo( *queryDate ) > 0 ){
+								if ( !( ( *checkDate >= current ) && 
+									( *checkDate <= *queryDate ) ) )
+									allcorrect = false;
+							}
 						}
 					}
-						break;
+
+					delete queryDate;
+					queryDate = 0l;
+					delete checkDate;
+					checkDate = 0l;
+					break;
+				default:
+					/* Just compare fields which are not empty in the query object */
+					if ( !query.field(i).isEmpty() ){
+						switch ( settings & ~( OContactAccess::IgnoreCase
+								       | OContactAccess::DateDiff
+								       | OContactAccess::DateYear
+								       | OContactAccess::DateMonth
+								       | OContactAccess::DateDay
+								       | OContactAccess::MatchOne 
+								      ) ){
+
+						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;
 	}
 
 	QArray<int> matchRegexp(  const QRegExp &r ) const{
 		QArray<int> m_currentQuery( m_contactList.count() );
 		QValueListConstIterator<OContact> it;
 		uint arraycounter = 0;
 		
 		for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 			if ( (*it).match( r ) ){
 				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 );
+				 | OContactAccess::IgnoreCase
+				 | OContactAccess::RegExp
+				 | OContactAccess::ExactMatch 
+				 | OContactAccess::DateDiff
+				 | OContactAccess::DateYear
+				 | OContactAccess::DateMonth
+				 | OContactAccess::DateDay
+				);
 		}
 	
 	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...
+			/* OContactAccess::IgnoreCase, DateDiff, DateYear, DateMonth, DateDay 
+			 * may be added with any of the other settings. IgnoreCase should never used alone.
+			 * Wildcards, RegExp, ExactMatch should never used at the same time...
 			 */
-			switch ( querySettings & ~OContactAccess::IgnoreCase ){
+
+			if ( querySettings == OContactAccess::IgnoreCase ) 
+				return false;
+
+			switch ( querySettings & ~( OContactAccess::IgnoreCase
+						    | OContactAccess::DateDiff
+						    | OContactAccess::DateYear
+						    | OContactAccess::DateMonth
+						    | OContactAccess::DateDay
+						  ) 
+			       ){
 			case OContactAccess::RegExp:
 				return ( true );
 			case OContactAccess::WildCards:
 				return ( true );
 			case OContactAccess::ExactMatch:
 				return ( true );
 			default:
 				return ( false );
 			}
 		}
 	
 	// Currently only asc implemented.. 
 	QArray<int> sorted( bool asc,  int , int ,  int ) 
 		{
 			QMap<QString, int> nameToUid;
 			QStringList names;
 			QArray<int> m_currentQuery( m_contactList.count() );
 
 			// First fill map and StringList with all Names 
 			// Afterwards sort namelist and use map to fill array to return..
 			QValueListConstIterator<OContact> it;
 			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 				names.append( (*it).fileAs() + QString::number( (*it).uid() ) );
 				nameToUid.insert( (*it).fileAs() + QString::number( (*it).uid() ), (*it).uid() );
 			}
 			names.sort();
 
 			int i = 0;
 			if ( asc ){
 				for ( QStringList::Iterator it = names.begin(); it != names.end(); ++it )
 					m_currentQuery[i++] = nameToUid[ (*it) ];
 			}else{
 				for ( QStringList::Iterator it = names.end(); it != names.begin(); --it )
 					m_currentQuery[i++] = nameToUid[ (*it) ];
 			}
 			
 			return m_currentQuery;
 			
 		}
 	bool add ( const OContact &newcontact )
 		{
 			//qWarning("odefaultbackend: ACTION::ADD");
 			updateJournal (newcontact, ACTION_ADD);
 			addContact_p( newcontact );
 			
 			m_changed = true;
 
 			return true;
 		}
 	
 	bool replace ( const OContact &contact )
 		{
 			m_changed = true;
 
 			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, ACTION_REPLACE);
 				m_contactList.remove (it);
 				m_contactList.append (contact);
 				return true;
 			} else
 				return false;
 		}
 	
 	bool remove ( int uid )
 		{
 			m_changed = true;
 
 			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, 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:
 
 	enum journal_action { ACTION_ADD, ACTION_REMOVE, ACTION_REPLACE };
 
 	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;
 		journal_action action = 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 );
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h
index 961968f..32b2dcb 100644
--- a/libopie2/opiepim/core/ocontactaccess.h
+++ b/libopie2/opiepim/core/ocontactaccess.h
@@ -1,150 +1,158 @@
 /*
  * Class to manage the Contacts.
  *
  * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
  * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org)
  *
  * =====================================================================
  *	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: Define enum for query settings
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.6  2003/01/02 14:27:12  eilers
+ * Improved query by example: Search by date is possible.. First step
+ * for a today plugin for birthdays..
+ *
  * Revision 1.5  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
  * Revision 1.4  2002/11/01 15:10:42  eilers
  * Added regExp-search in database for all fields in a contact.
  *
  * Revision 1.3  2002/10/16 10:52:40  eilers
  * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
  *
  * Revision 1.2  2002/10/14 16:21:54  eilers
  * Some minor interface updates
  *
  * 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 _OCONTACTACCESS_H
 #define _OCONTACTACCESS_H
 
 #include <qobject.h>
 
 #include <qpe/qcopenvelope_qws.h>
 
 #include <qvaluelist.h>
 #include <qfileinfo.h>
 
 #include "ocontact.h"
 #include "ocontactaccessbackend.h"
 #include "opimaccesstemplate.h"
 
 /** Class to access the contacts database.
  * This is just a frontend for the real database handling which is
  * done by the backend.
  * @see OPimAccessTemplate
  */
 class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 {
     Q_OBJECT
 
  public:
 	/** Create Database with contacts (addressbook).
 	 * @param appname Name of application which wants access to the database
 	 * (i.e. "todolist")
 	 * @param filename The name of the database file. If not set, the default one
 	 * is used.
 	 * @param backend Pointer to an alternative Backend. If not set, we will use
 	 * the default backend.
 	 * @param handlesync If <b>true</b> the database stores the current state
 	 * automatically if it receives the signals <i>flush()</i> and <i>reload()</i>
 	 * which are used before and after synchronisation. If the application wants
 	 * to react itself, it should be disabled by setting it to <b>false</b>
 	 * @see OContactAccessBackend
 	 */
 	OContactAccess (const QString appname, const QString filename = 0l,
                     OContactAccessBackend* backend = 0l, bool handlesync = true);
 	~OContactAccess ();
 
 	/** Constants for query.
 	 * Use this constants to set the query parameters.
 	 * Note: <i>query_IgnoreCase</i> just make sense with one of the other attributes !
 	 * @see queryByExample()
 	 */
 	enum QuerySettings {
 		WildCards  = 0x0001,
 		IgnoreCase = 0x0002,
 		RegExp     = 0x0004,
 		ExactMatch = 0x0008,
-		MatchOne   = 0x0010  // Only one Entry must match
+		MatchOne   = 0x0010, // Only one Entry must match
+		DateDiff   = 0x0020, // Find all entries from today until given date
+		DateYear   = 0x0040, // The year matches
+		DateMonth  = 0x0080, // The month matches
+		DateDay    = 0x0100, // The day matches
 	};
 
 	
 	ORecordList<OContact> matchRegexp(  const QRegExp &r )const;
 
 	/** Return all Contacts in a sorted manner.
 	 *  @param ascending true: Sorted in acending order.
 	 *  @param sortOrder Currently not implemented. Just defined to stay compatible to otodoaccess
 	 *  @param sortFilter Currently not implemented. Just defined to stay compatible to otodoaccess
 	 *  @param cat Currently not implemented. Just defined to stay compatible to otodoaccess
 	 */
 	List sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const;
 
 	/** Return all possible settings.
 	 *  @return All settings provided by the current backend
 	 * (i.e.: query_WildCards & query_IgnoreCase)
 	 */
 	const uint querySettings();
 
 	/** Check whether settings are correct.
 	 * @return <i>true</i> if the given settings are correct and possible.
 	 */
 	bool hasQuerySettings ( int querySettings ) const;
 
 	/**
 	 * if the resource was changed externally.
 	 * You should use the signal instead of polling possible changes !
 	 */
 	bool wasChangedExternally()const;
 
 
 	/** Save contacts database.
 	 * Save is more a "commit". After calling this function, all changes are public available.
 	 * @return true if successful
 	 */
 	bool save();
 
  signals:
 	/* Signal is emitted if the database was changed. Therefore
 	 * we may need to reload to stay consistent.
 	 * @param which Pointer to the database who created this event. This pointer
 	 * is useful if an application has to handle multiple databases at the same time.
 	 * @see reload()
 	 */
 	void signalChanged ( const OContactAccess *which );
 
 
  private:
 	// class OContactAccessPrivate;
 	// OContactAccessPrivate* d;
         OContactAccessBackend *m_backEnd;
         bool m_loading:1;
 
  private slots:
 	void copMessage( const QCString &msg, const QByteArray &data );
 
 
 };
 #endif