maryjane
/
syncevolution
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
syncevolution/src/backends/sqlite/SQLiteContactSource.h

115 lines
4.5 KiB
C
Raw Normal View History

added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
/*
copyright updated update-copyright.sh can be used to add copyright remarks for the current year. It finds the authors who made a change in each file and adds/updates their copyright remark. Intel employees are grouped under "Intel Corporation".
2009-03-25 15:21:04 +01:00
* Copyright (C) 2007-2009 Patrick Ohly <patrick.ohly@gmx.de>
license: changed to LGPL v2.1 + v3 As with the previous change from GPL to LGPL v2.1, this is covered by copyright ownership and/or the Funambol contributor agreement. The motivation for adding v3 is greater flexibility regarding reusing the code in other places and relicensing it. Also, now the license and disclaimer are mentioned at the start of the source files. That is not strictly necessary, but more explicit.
2009-04-30 18:14:03 +02:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
*/
#ifndef INCL_SQLITECONTACTSOURCE
#define INCL_SQLITECONTACTSOURCE
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
#include <syncevo/SyncSource.h>
#include <syncevo/PrefixConfigNode.h>
#include <syncevo/SafeConfigNode.h>
#include <SQLiteUtil.h>
files and classes renamed, include statements cleaned up The intention is to get rid of the historic and inconsistent naming of some classes and their corresponding files: * EvolutionSyncClient = class derived from Funambol's SyncClient, * SyncEvolutionConfig = SyncEvolution's config With the strict 'namespace SyncEvo' and the syncevo/ path prefix for most header files it is no longer necessary to have "SyncEvolution" or "Evolution" in the names. This patch thus renames as follows: EvolutionSyncClient => SyncContext EvolutionSmartPtr => SmartPtr SyncEvolutionCmdline => Cmdline SyncEvolutionConfig => SyncConfig SyncEvolutionUtil => util The former EvolutionSyncClient always had a role that went beyond just running a sync, for example it also provided config access. With the upcoming server support it also won't be just a client. Thus the new name "SyncContext". The 'syncevo/' prefix is used throughout the code now. removed whenever the prefix made it clear that the file belongs to SyncEvolution. This helps finding incorrect include paths. Quotes should be used exclusively for SyncEvolution files which don't have a specific prefix yet (test.h, config.h) to help identifying them.
2009-10-05 14:49:32 +02:00
#include <syncevo/declarations.h>
introduced "namespace SyncEvo" consistently Added syncevo/declarations.h, which has This is now used for all SyncEvolution source files, except for the GTK UI, which is written in plain C. In the library it helps to avoid name clashes. The reason for using defines instead of spelling out "namespace SyncEvo" is twofold: 1. if that should ever become necessary, it is easier to rename the namespace via configure options by changing the define 2. editors don't indent the whole file content
2009-10-02 17:23:53 +02:00
SE_BEGIN_CXX
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
#ifdef ENABLE_SQLITE
/**
turned SQLiteContactSource into a better example sync source - simplified the database schema by removing unused tables - added more per-contact properties missing in the original Apple schema - added comments - implemented storing of properties with 1:1 mapping to columns in database - simplified the test cases used for sqlite Client::Source::sqlite passes now. Client::Sync::sqlite still had some issues, partly network timeouts due to load on the server, partly problems in the client (?). git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@496 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-02-02 22:40:42 +01:00
* Uses SQLiteUtil for contacts with a schema inspired by the one used
* by Mac OS X. That schema has hierarchical tables which is not
* supported by SQLiteUtil, therefore SQLiteContactSource uses a
* simplified schema where each contact consists of one row in the
* database table.
*
* The handling of the "N" and "ORG" property shows how mapping
* between one property and multiple different columns works.
*
* Properties which can occur more than once per contact like address,
* email and phone numbers are not supported. They would have to be
* stored in additional tables.
*
* Change tracking is done by implementing a modification date as part
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
* of each contact and using that as the revision string.
turned SQLiteContactSource into a better example sync source - simplified the database schema by removing unused tables - added more per-contact properties missing in the original Apple schema - added comments - implemented storing of properties with 1:1 mapping to columns in database - simplified the test cases used for sqlite Client::Source::sqlite passes now. Client::Sync::sqlite still had some issues, partly network timeouts due to load on the server, partly problems in the client (?). git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@496 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-02-02 22:40:42 +01:00
* The database file is created automatically if the database ID is
* file:///<path>.
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
*/
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
class SQLiteContactSource : public SyncSource,
virtual public SyncSourceSession,
SQLite backend: added server admin calls The recently introduced enableServerMode() and serverModeEnabled() calls must be implemented by all sync sources not derived from TrackingSyncSource. This patch adds the calls to the SQLiteContactSource, using the default mechanism provided for it in SyncSourceAdmin.
2009-11-03 18:28:03 +01:00
virtual public SyncSourceAdmin,
enable suspend and saving blobs (MB #2425) Implement blob support. Blobs are stored in the per-peer source directory in a ".cache" sub-directory. We could have relied on the peer name and device name to make file names unique when sharing a common directory. Perhaps that is indeed the better solution: ~/.cache/syncevolution/blobs with logdir specifying the root? Blob support is only needed when running as server. When running as client, the binfile layer provides the necessary implementation. Support for suspend was off by default because <resumesupport> was not set. Adding it, because we should have whatever is needed. <resumeitemsupport> depends on the ability to store blobs. Not sure whether this is relevant on the client side, where these services are provided by the binfile layer.
2010-03-04 17:50:01 +01:00
virtual public SyncSourceBlob,
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
virtual public SyncSourceRevisions,
virtual public SyncSourceDelete,
virtual public SyncSourceLogging,
virtual public SyncSourceChanges
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
{
public:
redesigned SyncSource base class + API The main motivation for this change is that it allows the implementor of a backend to choose the implementations for the different aspects of a datasource (change tracking, item import/export, logging, ...) independently of each other. For example, change tracking via revision strings can now be combined with exchanging data with the Synthesis engine via a single string (the traditional method in SyncEvolution) and with direct access to the Synthesis field list (now possible for the first time). The new backend API is based on the concept of providing implementations for certain functionality via function objects instead of implementing certain virtual methods. The advantage is that implementors can define their own, custom interfaces and mix and match implementations of the different groups of functionality. Logging (see SyncSourceLogging in a later commit) can be done by wrapping some arbitrary other item import/export function objects (decorator design pattern). The class hierarchy is now this: - SyncSourceBase: interface for common utility code, all other classes are derived from it and thus can use that code - SyncSource: base class which implements SyncSourceBase and hooks a datasource into the SyncEvolution core; its "struct Operations" holds the function objects which can be implemented in different ways - TestingSyncSource: combines some of the following classes into an interface that is expected by the client-test program; backends only have to derive from (and implement this) if they want to use the automated testing - TrackingSyncSource: provides the same functionality as before (change tracking via revision strings, item import/export as string) in a single interface; the description of the pure virtual methods are duplicated so that developers can go through this class and find everything they need to know to implement it The following classes contain the code that was previously found in the EvolutionSyncSource base class. Implementors can derive from them and call the init() methods to inherit and activate the functionality: - SyncSourceSession: binds Synthesis session callbacks to virtual methods beginSync(), endSync() - SyncSourceChanges: implements Synthesis item tracking callbacks with set of LUIDs that the user of the class has to fill - SyncSourceDelete: binds Synthesis delete callback to virtual method - SyncSourceRaw: read and write items in the backends format, used for testing and backup/restore - SyncSourceSerialize: exchanges items with Synthesis engine using a string representation of the data; this is how EvolutionSyncSource has traditionally worked, so much of the same virtual methods are now in this class - SyncSourceRevisions: utility class which does change tracking via some kind of "revision" string which changes each time an item is modified; this code was previously in the TrackingSyncSource
2009-08-25 09:27:46 +02:00
SQLiteContactSource(const SyncSourceParams &params) :
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
SyncSource(params),
m_trackingNode(new PrefixConfigNode("item-",
C++: replace boost::shared_ptr, boost::function, boost::bind We can use std::shared_ptr and std::function instead now. Lambdas are usually a better alternative to boost/std::bind. The downside is the need to explicitly specify parameters completely. When inlining callbacks entirely with lambdas, duplication of that parameter list can be avoided. Whenever possible, use std::make_shared to construct objects that are tracked by std::shared_ptr. Some objects need a std::weak_ptr during object destruction. For that we have to use our own implementation of std::enable_shared_from_this, with a matching creator function. The additional benefit is that we can get rid of explicit static "create" methods by making that create function a friend. Signed-off-by: Patrick Ohly <patrick.ohly@intel.com>
2018-01-16 17:17:34 +01:00
std::static_pointer_cast<ConfigNode>(std::make_shared<SafeConfigNode>(params.m_nodes.getTrackingNode()))))
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
{
SyncSourceSession::init(m_operations);
SyncSourceDelete::init(m_operations);
SyncSourceRevisions::init(NULL, NULL, 1, m_operations);
SyncSourceChanges::init(m_operations);
C++: replace boost::shared_ptr, boost::function, boost::bind We can use std::shared_ptr and std::function instead now. Lambdas are usually a better alternative to boost/std::bind. The downside is the need to explicitly specify parameters completely. When inlining callbacks entirely with lambdas, duplication of that parameter list can be avoided. Whenever possible, use std::make_shared to construct objects that are tracked by std::shared_ptr. Some objects need a std::weak_ptr during object destruction. For that we have to use our own implementation of std::enable_shared_from_this, with a matching creator function. The additional benefit is that we can get rid of explicit static "create" methods by making that create function a friend. Signed-off-by: Patrick Ohly <patrick.ohly@intel.com>
2018-01-16 17:17:34 +01:00
m_operations.m_isEmpty = [this] () { return isEmpty(); };
m_operations.m_readItemAsKey = [this] (sysync::cItemID aID, sysync::KeyH aItemKey) { return readItemAsKey(aID, aItemKey); };
m_operations.m_insertItemAsKey = [this] (sysync::KeyH aItemKey, sysync::ItemID newID) { return insertItemAsKey(aItemKey, (sysync::cItemID)NULL, newID); };
m_operations.m_updateItemAsKey = [this] (sysync::KeyH aItemKey, sysync::cItemID aID, sysync::ItemID newID) { return insertItemAsKey(aItemKey, aID, newID); };
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
SyncSourceLogging::init(InitList<std::string> ("N_FIRST")+"N_MIDDLE"+"N_LAST", ", ", m_operations);
}
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
protected:
redesigned SyncSource base class + API The main motivation for this change is that it allows the implementor of a backend to choose the implementations for the different aspects of a datasource (change tracking, item import/export, logging, ...) independently of each other. For example, change tracking via revision strings can now be combined with exchanging data with the Synthesis engine via a single string (the traditional method in SyncEvolution) and with direct access to the Synthesis field list (now possible for the first time). The new backend API is based on the concept of providing implementations for certain functionality via function objects instead of implementing certain virtual methods. The advantage is that implementors can define their own, custom interfaces and mix and match implementations of the different groups of functionality. Logging (see SyncSourceLogging in a later commit) can be done by wrapping some arbitrary other item import/export function objects (decorator design pattern). The class hierarchy is now this: - SyncSourceBase: interface for common utility code, all other classes are derived from it and thus can use that code - SyncSource: base class which implements SyncSourceBase and hooks a datasource into the SyncEvolution core; its "struct Operations" holds the function objects which can be implemented in different ways - TestingSyncSource: combines some of the following classes into an interface that is expected by the client-test program; backends only have to derive from (and implement this) if they want to use the automated testing - TrackingSyncSource: provides the same functionality as before (change tracking via revision strings, item import/export as string) in a single interface; the description of the pure virtual methods are duplicated so that developers can go through this class and find everything they need to know to implement it The following classes contain the code that was previously found in the EvolutionSyncSource base class. Implementors can derive from them and call the init() methods to inherit and activate the functionality: - SyncSourceSession: binds Synthesis session callbacks to virtual methods beginSync(), endSync() - SyncSourceChanges: implements Synthesis item tracking callbacks with set of LUIDs that the user of the class has to fill - SyncSourceDelete: binds Synthesis delete callback to virtual method - SyncSourceRaw: read and write items in the backends format, used for testing and backup/restore - SyncSourceSerialize: exchanges items with Synthesis engine using a string representation of the data; this is how EvolutionSyncSource has traditionally worked, so much of the same virtual methods are now in this class - SyncSourceRevisions: utility class which does change tracking via some kind of "revision" string which changes each time an item is modified; this code was previously in the TrackingSyncSource
2009-08-25 09:27:46 +02:00
/* implementation of SyncSource interface */
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
virtual void open();
Replaced "is a" SQLiteSyncSource with "has a" SQLiteUtil instance in SQLiteContactSource. This is a first step towards deriving SQLiteContactSource from a sync source base class which does change tracking. git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@483 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-01-13 00:22:43 +01:00
virtual void close();
cleaned up EvolutionSyncSource interface+implementation git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@664 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-07-10 21:17:42 +02:00
virtual Databases getDatabases();
SQLite backend: added server admin calls The recently introduced enableServerMode() and serverModeEnabled() calls must be implemented by all sync sources not derived from TrackingSyncSource. This patch adds the calls to the SQLiteContactSource, using the default mechanism provided for it in SyncSourceAdmin.
2009-11-03 18:28:03 +01:00
virtual void enableServerMode();
virtual bool serverModeEnabled() const;
SQLite backend: adapted to SyncSource API changes Failed to build because getPeerMimeType() now uses a std::string as return type. getMimeType[Version]() are no longer needed for sources derived from SyncSource.
2011-05-02 14:29:56 +02:00
virtual std::string getPeerMimeType() const { return "text/x-vcard"; }
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
/* Methods in SyncSource */
virtual void getSynthesisInfo (SynthesisInfo &info, XMLConfigFragments &fragment);
sysync::TSyError readItemAsKey(sysync::cItemID aID, sysync::KeyH aItemKey);
sysync::TSyError insertItemAsKey(sysync::KeyH aItemKey, sysync::cItemID aID, sysync::ItemID newID);
implemented full change tracking in demo SQLiteContactSource with new TrackingSyncSource base class git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@486 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-01-14 22:25:03 +01:00
Enable SQlite backends (MB#5049) SQLite backends is supported with new syncsoruce api. This demostrates how to access synthesis data field directly. Change tracking is done the same as TrackingSyncSource.
2009-09-27 11:38:42 +02:00
/* Methods in SyncSourceSession*/
virtual void beginSync(const std::string &lastToken, const std::string &resumeToken);
virtual std::string endSync(bool success);
/* Methods in SyncSourceDelete*/
virtual void deleteItem(const string &luid);
/* Methods in SyncSourceRevisions */
virtual void listAllItems(RevisionMap_t &revisions);
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
private:
Replaced "is a" SQLiteSyncSource with "has a" SQLiteUtil instance in SQLiteContactSource. This is a first step towards deriving SQLiteContactSource from a sync source base class which does change tracking. git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@483 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-01-13 00:22:43 +01:00
/** encapsulates access to database */
C++: replace boost::shared_ptr, boost::function, boost::bind We can use std::shared_ptr and std::function instead now. Lambdas are usually a better alternative to boost/std::bind. The downside is the need to explicitly specify parameters completely. When inlining callbacks entirely with lambdas, duplication of that parameter list can be avoided. Whenever possible, use std::make_shared to construct objects that are tracked by std::shared_ptr. Some objects need a std::weak_ptr during object destruction. For that we have to use our own implementation of std::enable_shared_from_this, with a matching creator function. The additional benefit is that we can get rid of explicit static "create" methods by making that create function a friend. Signed-off-by: Patrick Ohly <patrick.ohly@intel.com>
2018-01-16 17:17:34 +01:00
std::shared_ptr<ConfigNode> m_trackingNode;
Replaced "is a" SQLiteSyncSource with "has a" SQLiteUtil instance in SQLiteContactSource. This is a first step towards deriving SQLiteContactSource from a sync source base class which does change tracking. git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@483 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-01-13 00:22:43 +01:00
SQLiteUtil m_sqlite;
SQLite backend: implement m_isEmpty operation (MB #7708) This patch demonstrates how the operation can be implemented by sources implementing the operations themselves. The implementation of SQLiteContactSource::isEmpty() might not be perfect, but it should get the job done.
2010-02-16 20:15:50 +01:00
/** implements the m_isEmpty operation */
bool isEmpty();
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
};
#endif // ENABLE_SQLITE
introduced "namespace SyncEvo" consistently Added syncevo/declarations.h, which has This is now used for all SyncEvolution source files, except for the GTK UI, which is written in plain C. In the library it helps to avoid name clashes. The reason for using defines instead of spelling out "namespace SyncEvo" is twofold: 1. if that should ever become necessary, it is easier to rename the namespace via configure options by changing the define 2. editors don't indent the whole file content
2009-10-02 17:23:53 +02:00
SE_END_CXX
added a sync source which stores contacts in a SQLite database git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@381 15ad00c4-1369-45f4-8270-35d70d36bdcd
2007-08-13 22:46:49 +02:00
#endif // INCL_SQLITECONTACTSOURCE