2005-11-05 23:04:33 +01:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2005 Patrick Ohly
|
|
|
|
*
|
|
|
|
* 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 "EvolutionSyncSource.h"
|
|
|
|
#include "EvolutionSmartPtr.h"
|
|
|
|
|
|
|
|
#include <libebook/e-book.h>
|
|
|
|
#include <libebook/e-vcard.h>
|
|
|
|
|
2006-03-12 23:30:35 +01:00
|
|
|
#include <set>
|
|
|
|
|
2005-11-05 23:04:33 +01:00
|
|
|
/**
|
|
|
|
* Implements access to Evolution address books.
|
|
|
|
*/
|
|
|
|
class EvolutionContactSource : public EvolutionSyncSource
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Creates a new Evolution address book source.
|
2005-11-26 22:16:03 +01:00
|
|
|
*
|
2005-11-05 23:04:33 +01:00
|
|
|
* @param changeId is used to track changes in the Evolution backend;
|
|
|
|
* not specifying it implies that always all items are returned
|
|
|
|
* @param id identifies the backend; not specifying it makes this instance
|
|
|
|
* unusable for anything but listing backend databases
|
|
|
|
*/
|
|
|
|
EvolutionContactSource( const string &name,
|
|
|
|
const string &changeId = string(""),
|
|
|
|
const string &id = string(""),
|
2005-11-26 22:16:03 +01:00
|
|
|
EVCardFormat vcardFormat = EVC_FORMAT_VCARD_30 );
|
2006-01-08 22:49:03 +01:00
|
|
|
EvolutionContactSource( const EvolutionContactSource &other );
|
2006-04-09 13:48:11 +02:00
|
|
|
virtual ~EvolutionContactSource() { close(); }
|
2005-11-05 23:04:33 +01:00
|
|
|
|
2006-01-08 22:49:03 +01:00
|
|
|
//
|
|
|
|
// utility function for testing:
|
|
|
|
// returns a pointer to an Evolution contact (memory owned
|
|
|
|
// by Evolution) with the given UID, NULL if not found or failure
|
|
|
|
//
|
|
|
|
EContact *getContact( const string &uid );
|
|
|
|
|
|
|
|
// utility function: extract vcard from item in format suitable for Evolution
|
|
|
|
string preparseVCard(SyncItem& item);
|
|
|
|
|
2005-11-05 23:04:33 +01:00
|
|
|
//
|
|
|
|
// implementation of EvolutionSyncSource
|
|
|
|
//
|
|
|
|
virtual sources getSyncBackends();
|
|
|
|
virtual void open();
|
2006-03-18 14:35:23 +01:00
|
|
|
virtual void close();
|
|
|
|
virtual void exportData(ostream &out);
|
2006-03-19 22:37:30 +01:00
|
|
|
virtual string fileSuffix() { return "vcf"; }
|
2006-03-18 14:35:23 +01:00
|
|
|
|
2005-11-25 21:53:04 +01:00
|
|
|
virtual SyncItem *createItem( const string &uid, SyncState state );
|
2006-04-09 13:48:11 +02:00
|
|
|
|
2005-11-05 23:04:33 +01:00
|
|
|
//
|
|
|
|
// implementation of SyncSource
|
|
|
|
//
|
2006-01-08 22:49:03 +01:00
|
|
|
virtual ArrayElement *clone() { return new EvolutionContactSource(*this); }
|
|
|
|
|
2006-04-09 13:48:11 +02:00
|
|
|
protected:
|
|
|
|
//
|
|
|
|
// implementation of EvolutionSyncSource callbacks
|
|
|
|
//
|
|
|
|
virtual void beginSyncThrow(bool needAll,
|
|
|
|
bool needPartial,
|
|
|
|
bool deleteLocal);
|
|
|
|
virtual void endSyncThrow();
|
|
|
|
virtual void setItemStatusThrow(const char *key, int status);
|
|
|
|
virtual void addItemThrow(SyncItem& item);
|
|
|
|
virtual void updateItemThrow(SyncItem& item);
|
|
|
|
virtual void deleteItemThrow(SyncItem& item);
|
|
|
|
virtual void logItem(const string &uid, const string &info);
|
|
|
|
virtual void logItem(SyncItem &item, const string &info);
|
|
|
|
|
2005-11-05 23:04:33 +01:00
|
|
|
private:
|
|
|
|
/** valid after open(): the address book that this source references */
|
|
|
|
gptr<EBook, GObject> m_addressbook;
|
|
|
|
|
|
|
|
/** the format of vcards that new items are expected to have */
|
|
|
|
const EVCardFormat m_vcardFormat;
|
|
|
|
|
2006-03-12 23:30:35 +01:00
|
|
|
/**
|
|
|
|
* a list of Evolution vcard properties which have to be encoded
|
|
|
|
* as X-SYNCEVOLUTION-* when sending to server in 2.1 and decoded
|
|
|
|
* back when receiving.
|
|
|
|
*/
|
|
|
|
static const class extensions : public set<string> {
|
|
|
|
public:
|
|
|
|
extensions() : prefix("X-SYNCEVOLUTION-") {
|
|
|
|
this->insert("FBURL");
|
|
|
|
this->insert("CALURI");
|
|
|
|
}
|
|
|
|
|
|
|
|
const string prefix;
|
|
|
|
} m_vcardExtensions;
|
|
|
|
|
2006-03-18 15:18:14 +01:00
|
|
|
/**
|
|
|
|
* a list of properties which SyncEvolution (in contrast to
|
|
|
|
* the server) will only store once in each contact
|
|
|
|
*/
|
|
|
|
static const class unique : public set<string> {
|
|
|
|
public:
|
|
|
|
unique () {
|
|
|
|
insert("X-AIM");
|
|
|
|
insert("X-GROUPWISE");
|
|
|
|
insert("X-ICQ");
|
|
|
|
insert("X-YAHOO");
|
|
|
|
insert("X-EVOLUTION-ANNIVERSARY");
|
|
|
|
insert("X-EVOLUTION-ASSISTANT");
|
|
|
|
insert("X-EVOLUTION-BLOG-URL");
|
|
|
|
insert("X-EVOLUTION-FILE-AS");
|
|
|
|
insert("X-EVOLUTION-MANAGER");
|
|
|
|
insert("X-EVOLUTION-SPOUSE");
|
|
|
|
insert("X-EVOLUTION-VIDEO-URL");
|
|
|
|
insert("X-MOZILLA-HTML");
|
|
|
|
insert("FBURL");
|
|
|
|
insert("CALURI");
|
|
|
|
}
|
|
|
|
} m_uniqueProperties;
|
|
|
|
|
2005-11-05 23:04:33 +01:00
|
|
|
/** the mime type which corresponds to m_vcardFormat */
|
|
|
|
const char *getMimeType();
|
|
|
|
};
|