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
|
/*
* Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
#include "facadeinterface.h"
#include <QByteArray>
#include <Async/Async>
#include "resourceaccess.h"
#include "commands.h"
#include "domainadaptor.h"
#include "log.h"
#include "resultset.h"
#include "entitystorage.h"
/**
* A QueryRunner runs a query and updates the corresponding result set.
*
* The lifetime of the QueryRunner is defined by the resut set (otherwise it's doing useless work),
* and by how long a result set must be updated. If the query is one off the runner dies after the execution,
* otherwise it lives on the react to changes and updates the corresponding result set.
*
* QueryRunner has to keep ResourceAccess alive in order to keep getting updates.
*/
class QueryRunner : public QObject
{
Q_OBJECT
public:
typedef std::function<KAsync::Job<qint64>(qint64 oldRevision)> QueryFunction;
QueryRunner(const Akonadi2::Query &query) : mLatestRevision(0) {};
/**
* Starts query
*/
KAsync::Job<void> run(qint64 newRevision = 0)
{
//TODO: JOBAPI: that last empty .then should not be necessary
//TODO: remove newRevision
return queryFunction(mLatestRevision + 1).then<void, qint64>([this](qint64 revision) {
mLatestRevision = revision;
}).then<void>([](){});
}
/**
* Set the query to run
*/
void setQuery(const QueryFunction &query)
{
queryFunction = query;
}
public slots:
/**
* Rerun query with new revision
*/
void revisionChanged(qint64 newRevision)
{
Trace() << "New revision: " << newRevision;
run(newRevision).exec();
}
private:
QueryFunction queryFunction;
qint64 mLatestRevision;
};
namespace Akonadi2 {
/**
* Default facade implementation for resources that are implemented in a separate process using the ResourceAccess class.
*
* Ideally a basic resource has no implementation effort for the facades and can simply instanciate default implementations (meaning it only has to implement the factory with all supported types).
* A resource has to implement:
* * A facade factory registering all available facades
* * An adaptor factory if it uses special resource buffers (default implementation can be used otherwise)
* * A mapping between resource and buffertype if default can't be used.
*
* Additionally a resource only has to provide a synchronizer plugin to execute the synchronization
*/
template <typename DomainType>
class GenericFacade: public Akonadi2::StoreFacade<DomainType>
{
public:
/**
* Create a new GenericFacade
*
* @param resourceIdentifier is the identifier of the resource instance
* @param adaptorFactory is the adaptor factory used to generate the mappings from domain to resource types and vice versa
*/
GenericFacade(const QByteArray &resourceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory = DomainTypeAdaptorFactoryInterface::Ptr(), const QSharedPointer<EntityStorage<DomainType> > storage = QSharedPointer<EntityStorage<DomainType> >(), const QSharedPointer<Akonadi2::ResourceAccessInterface> resourceAccess = QSharedPointer<Akonadi2::ResourceAccessInterface>())
: Akonadi2::StoreFacade<DomainType>(),
mResourceAccess(resourceAccess),
mStorage(storage ? storage : QSharedPointer<EntityStorage<DomainType> >::create(resourceIdentifier, adaptorFactory, bufferTypeForDomainType())),
mDomainTypeAdaptorFactory(adaptorFactory),
mResourceInstanceIdentifier(resourceIdentifier)
{
if (!mResourceAccess) {
mResourceAccess = QSharedPointer<Akonadi2::ResourceAccess>::create(resourceIdentifier);
}
}
~GenericFacade()
{
}
static QByteArray bufferTypeForDomainType()
{
//We happen to have a one to one mapping
return Akonadi2::ApplicationDomain::getTypeName<DomainType>();
}
KAsync::Job<void> create(const DomainType &domainObject) Q_DECL_OVERRIDE
{
if (!mDomainTypeAdaptorFactory) {
Warning() << "No domain type adaptor factory available";
return KAsync::error<void>();
}
flatbuffers::FlatBufferBuilder entityFbb;
mDomainTypeAdaptorFactory->createBuffer(domainObject, entityFbb);
return mResourceAccess->sendCreateCommand(bufferTypeForDomainType(), QByteArray::fromRawData(reinterpret_cast<const char*>(entityFbb.GetBufferPointer()), entityFbb.GetSize()));
}
KAsync::Job<void> modify(const DomainType &domainObject) Q_DECL_OVERRIDE
{
if (!mDomainTypeAdaptorFactory) {
Warning() << "No domain type adaptor factory available";
return KAsync::error<void>();
}
flatbuffers::FlatBufferBuilder entityFbb;
mDomainTypeAdaptorFactory->createBuffer(domainObject, entityFbb);
return mResourceAccess->sendModifyCommand(domainObject.identifier(), domainObject.revision(), bufferTypeForDomainType(), QByteArrayList(), QByteArray::fromRawData(reinterpret_cast<const char*>(entityFbb.GetBufferPointer()), entityFbb.GetSize()));
}
KAsync::Job<void> remove(const DomainType &domainObject) Q_DECL_OVERRIDE
{
return mResourceAccess->sendDeleteCommand(domainObject.identifier(), domainObject.revision(), bufferTypeForDomainType());
}
//TODO JOBAPI return job from sync continuation to execute it as subjob?
KAsync::Job<void> load(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > &resultProvider) Q_DECL_OVERRIDE
{
auto runner = QSharedPointer<QueryRunner>::create(query);
QWeakPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > weakResultProvider = resultProvider;
runner->setQuery([this, weakResultProvider, query] (qint64 oldRevision) -> KAsync::Job<qint64> {
return KAsync::start<qint64>([this, weakResultProvider, query, oldRevision](KAsync::Future<qint64> &future) {
Trace() << "Executing query " << oldRevision;
auto resultProvider = weakResultProvider.toStrongRef();
if (!resultProvider) {
Warning() << "Tried executing query after result provider is already gone";
future.setError(0, QString());
future.setFinished();
return;
}
load(query, resultProvider, oldRevision).template then<void, qint64>([&future](qint64 queriedRevision) {
//TODO set revision in result provider?
//TODO update all existing results with new revision
future.setValue(queriedRevision);
future.setFinished();
}).exec();
});
});
//In case of a live query we keep the runner for as long alive as the result provider exists
if (query.liveQuery) {
resultProvider->setQueryRunner(runner);
//Ensure the connection is open, if it wasn't already opened
//TODO If we are not connected already, we have to check for the latest revision once connected, otherwise we could miss some updates
mResourceAccess->open();
QObject::connect(mResourceAccess.data(), &Akonadi2::ResourceAccess::revisionChanged, runner.data(), &QueryRunner::revisionChanged);
}
//We have to capture the runner to keep it alive
return synchronizeResource(query.syncOnDemand, query.processAll).template then<void>([runner](KAsync::Future<void> &future) {
runner->run().then<void>([&future]() {
future.setFinished();
}).exec();
});
}
protected:
KAsync::Job<void> synchronizeResource(bool sync, bool processAll)
{
//TODO check if a sync is necessary
//TODO Only sync what was requested
//TODO timeout
if (sync || processAll) {
return KAsync::start<void>([=](KAsync::Future<void> &future) {
mResourceAccess->synchronizeResource(sync, processAll).then<void>([&future]() {
future.setFinished();
}).exec();
});
}
return KAsync::null<void>();
}
private:
virtual KAsync::Job<qint64> load(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > &resultProvider, qint64 oldRevision)
{
return KAsync::start<qint64>([=]() -> qint64 {
return mStorage->read(query, oldRevision, resultProvider);
});
}
protected:
//TODO use one resource access instance per application & per resource
QSharedPointer<Akonadi2::ResourceAccessInterface> mResourceAccess;
QSharedPointer<EntityStorage<DomainType> > mStorage;
DomainTypeAdaptorFactoryInterface::Ptr mDomainTypeAdaptorFactory;
QByteArray mResourceInstanceIdentifier;
};
}
|
