Moved all generic synchronization code to the base class.

1 files changed, 44 insertions, 0 deletions

diff --git a/common/genericresource.h b/common/genericresource.h
index ea68a25..c12c631 100644
--- a/common/genericresource.h
+++ b/common/genericresource.h
@@ -63,6 +63,50 @@ protected:
     virtual KAsync::Job<void> replay(const QByteArray &type, const QByteArray &key, const QByteArray &value);
     void onProcessorError(int errorCode, const QString &errorMessage);
     void enqueueCommand(MessageQueue &mq, int commandId, const QByteArray &data);
+
+    static void createEntity(const QByteArray &localId, const QByteArray &bufferType, const Akonadi2::ApplicationDomain::ApplicationDomainType &domainObject, DomainTypeAdaptorFactoryInterface &adaptorFactory, std::function<void(const QByteArray &)> callback);
+    static void modifyEntity(const QByteArray &localId, qint64 revision, const QByteArray &bufferType, const Akonadi2::ApplicationDomain::ApplicationDomainType &domainObject, DomainTypeAdaptorFactoryInterface &adaptorFactory, std::function<void(const QByteArray &)> callback);
+    static void deleteEntity(const QByteArray &localId, qint64 revision, const QByteArray &bufferType, std::function<void(const QByteArray &)> callback);
+
+    /**
+     * Records a localId to remoteId mapping
+     */
+    void recordRemoteId(const QByteArray &bufferType, const QByteArray &localId, const QByteArray &remoteId, Akonadi2::Storage::Transaction &transaction);
+    void removeRemoteId(const QByteArray &bufferType, const QByteArray &localId, const QByteArray &remoteId, Akonadi2::Storage::Transaction &transaction);
+
+    /**
+     * Tries to find a local id for the remote id, and creates a new local id otherwise.
+     * 
+     * The new local id is recorded in the local to remote id mapping.
+     */
+    QByteArray resolveRemoteId(const QByteArray &type, const QByteArray &remoteId, Akonadi2::Storage::Transaction &transaction);
+
+    /**
+     * Tries to find a remote id for a local id.
+     * 
+     * This can fail if the entity hasn't been written back to the server yet.
+     */
+    QByteArray resolveLocalId(const QByteArray &bufferType, const QByteArray &localId, Akonadi2::Storage::Transaction &transaction);
+
+    /**
+    * A synchronous algorithm to remove entities that are no longer existing.
+    * 
+    * A list of entities is generated by @param entryGenerator.
+    * The entiry Generator typically iterates over an index to produce all existing entries.
+    * This algorithm calls @param exists for every entity of type @param type, with its remoteId. For every entity where @param exists returns false,
+    * an entity delete command is enqueued.
+    * 
+    * All functions are called synchronously, and both @param entryGenerator and @param exists need to be synchronous.
+    */
+    void scanForRemovals(Akonadi2::Storage::Transaction &transaction, Akonadi2::Storage::Transaction &synchronizationTransaction, const QByteArray &bufferType, const std::function<void(const std::function<void(const QByteArray &key)> &callback)> &entryGenerator, std::function<bool(const QByteArray &remoteId)> exists);
+
+    /**
+     * An algorithm to create or modify the entity.
+     *
+     * Depending on whether the entity is locally available, or has changed.
+     */
+    void createOrModify(Akonadi2::Storage::Transaction &transaction, Akonadi2::Storage::Transaction &synchronizationTransaction, DomainTypeAdaptorFactoryInterface &adaptorFactory, const QByteArray &bufferType, const QByteArray &remoteId, const Akonadi2::ApplicationDomain::ApplicationDomainType &entity);
+
     MessageQueue mUserQueue;
     MessageQueue mSynchronizerQueue;
     QByteArray mResourceInstanceIdentifier;