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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library 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.
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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_RESOURCESCHEDULER_P_H
#define AKONADI_RESOURCESCHEDULER_P_H
#include <akonadi/agentbase.h>
#include <akonadi/collection.h>
#include <akonadi/item.h>
#include <akonadi/resourcebase.h>
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtDBus/QDBusMessage>
namespace Akonadi {
class RecursiveMover;
//@cond PRIVATE
/**
@internal
Manages synchronization and fetch requests for a resource.
@todo Attach to the ResourceBase Monitor,
*/
class ResourceScheduler : public QObject
{
Q_OBJECT
public:
// If you change this enum, keep s_taskTypes in sync in resourcescheduler.cpp
enum TaskType {
Invalid,
SyncAll,
SyncCollectionTree,
SyncCollection,
SyncCollectionAttributes,
FetchItem,
ChangeReplay,
RecursiveMoveReplay,
DeleteResourceCollection,
InvalideCacheForCollection,
SyncAllDone,
SyncCollectionTreeDone,
Custom
};
class Task {
static qint64 latestSerial;
public:
Task() : serial( ++latestSerial ), type( Invalid ), receiver( 0 ) {}
qint64 serial;
TaskType type;
Collection collection;
Item item;
QSet<QByteArray> itemParts;
QList<QDBusMessage> dbusMsgs;
QObject *receiver;
QByteArray methodName;
QVariant argument;
void sendDBusReplies( const QString &errorMsg );
bool operator==( const Task &other ) const
{
return type == other.type
&& (collection == other.collection || (!collection.isValid() && !other.collection.isValid()))
&& (item == other.item || (!item.isValid() && !other.item.isValid()))
&& itemParts == other.itemParts
&& receiver == other.receiver
&& methodName == other.methodName
&& argument == other.argument;
}
};
ResourceScheduler( QObject *parent = 0 );
/**
Schedules a full synchronization.
*/
void scheduleFullSync();
/**
Schedules a collection tree sync.
*/
void scheduleCollectionTreeSync();
/**
Schedules the synchronization of a single collection.
@param col The collection to synchronize.
*/
void scheduleSync( const Collection &col );
/**
Schedules synchronizing the attributes of a single collection.
@param collection The collection to synchronize attributes from.
*/
void scheduleAttributesSync( const Collection &collection );
/**
Schedules fetching of a single PIM item.
@param item The item to fetch.
@param parts List of names of the parts of the item to fetch.
@param msg The associated D-Bus message.
*/
void scheduleItemFetch( const Item &item, const QSet<QByteArray> &parts, const QDBusMessage &msg );
/**
Schedules deletion of the resource collection.
This method is used to implement the ResourceBase::clearCache() functionality.
*/
void scheduleResourceCollectionDeletion();
/**
* Schedule cache invalidation for @p collection.
* @see ResourceBase::invalidateCache()
*/
void scheduleCacheInvalidation( const Collection &collection );
/**
Insert synchronization completion marker into the task queue.
*/
void scheduleFullSyncCompletion();
/**
Insert collection tree synchronization completion marker into the task queue.
*/
void scheduleCollectionTreeSyncCompletion();
/**
Insert a custom task.
@param methodName The method name, without signature, do not use the SLOT() macro
*/
void scheduleCustomTask( QObject *receiver, const char *methodName, const QVariant &argument, ResourceBase::SchedulePriority priority = ResourceBase::Append );
/**
* Schedule a recursive move replay.
*/
void scheduleMoveReplay( const Collection &movedCollection, RecursiveMover *mover );
/**
Returns true if no tasks are running or in the queue.
*/
bool isEmpty();
/**
Returns the current task.
*/
Task currentTask() const;
/**
Sets the online state.
*/
void setOnline( bool state );
/**
Print debug output showing the state of the scheduler.
*/
void dump();
/**
Print debug output showing the state of the scheduler.
*/
QString dumpToString() const;
/**
Clear the state of the scheduler. Warning: this is intended to be
used purely in debugging scenarios, as it might cause loss of uncommitted
local changes.
*/
void clear();
/**
Cancel everything the scheduler has still in queue. Keep the current task running though.
It can be seen as a less aggressive clear() used when the user requested the resource to
abort its activities. It properly cancel all the tasks in there.
*/
void cancelQueues();
public Q_SLOTS:
/**
Schedules replaying changes.
*/
void scheduleChangeReplay();
/**
The current task has been finished
*/
void taskDone();
/**
The current task can't be finished now and will be rescheduled later
*/
void deferTask();
/**
Remove tasks that affect @p collection.
*/
void collectionRemoved( const Akonadi::Collection &collection );
Q_SIGNALS:
void executeFullSync();
void executeCollectionAttributesSync( const Akonadi::Collection &col );
void executeCollectionSync( const Akonadi::Collection &col );
void executeCollectionTreeSync();
void executeItemFetch( const Akonadi::Item &item, const QSet<QByteArray> &parts );
void executeResourceCollectionDeletion();
void executeCacheInvalidation( const Akonadi::Collection &collection );
void executeChangeReplay();
void executeRecursiveMoveReplay( RecursiveMover *mover );
void collectionTreeSyncComplete();
void fullSyncComplete();
void status( int status, const QString &message = QString() );
private slots:
void scheduleNext();
void executeNext();
private:
void signalTaskToTracker( const Task &task, const QByteArray &taskType );
// We have a number of task queues, by order of priority.
// * ChangeReplay must be first:
// change replays have to happen before we pull changes from the backend, otherwise
// we will overwrite our still unsaved local changes if the backend can't do
// incremental retrieval
//
// * then the stuff that is "immediately after change replay", like writeFile calls.
// * then ItemFetch tasks, because they are made by blocking DBus calls
// * then everything else.
enum QueueType {
PrependTaskQueue,
ChangeReplayQueue, // one task at most
AfterChangeReplayQueue, // also one task at most, currently
ItemFetchQueue,
GenericTaskQueue,
NQueueCount
};
typedef QList<Task> TaskList;
static QueueType queueTypeForTaskType( TaskType type );
TaskList& queueForTaskType( TaskType type );
TaskList mTaskList[ NQueueCount ];
Task mCurrentTask;
int mCurrentTasksQueue; // queue mCurrentTask came from
bool mOnline;
};
QDebug operator<<( QDebug, const ResourceScheduler::Task& task );
QTextStream& operator<<( QTextStream&, const ResourceScheduler::Task& task );
//@endcond
}
#endif
|