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
|
/*
* Copyright (C) 2018 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 "synchronizer.h"
#include <KDAV2/DavCollection>
#include <KDAV2/DavItem>
#include <KDAV2/DavUrl>
class WebDavSynchronizer : public Sink::Synchronizer
{
public:
WebDavSynchronizer(const Sink::ResourceContext &, KDAV2::Protocol, QByteArray collectionName,
QByteArray itemName);
QList<Synchronizer::SyncRequest> getSyncRequests(const Sink::QueryBase &query) Q_DECL_OVERRIDE;
KAsync::Job<void> synchronizeWithSource(const Sink::QueryBase &query) Q_DECL_OVERRIDE;
protected:
/**
* Called in a child synchronizer, when replaying a creation of an item.
*/
KAsync::Job<void> createItem(const KDAV2::DavItem &);
/**
* Called in a child synchronizer, when replaying a removal of an item.
*/
KAsync::Job<void> removeItem(const KDAV2::DavItem &);
/**
* Called in a child synchronizer, when replaying a modification of an item.
*
* The item to modify is chosen according to the given item's URL.
* The job will fail if the ETag does not match.
*/
KAsync::Job<void> modifyItem(const KDAV2::DavItem &);
/**
* See comments of the *Item version above
*/
KAsync::Job<void> createCollection(const KDAV2::DavUrl &);
KAsync::Job<void> removeCollection(const KDAV2::DavUrl &);
KAsync::Job<void> modifyCollection(const KDAV2::DavUrl &);
/**
* Called with the list of discovered collections. It's purpose should be
* adding the said collections to the store.
*/
virtual void updateLocalCollections(KDAV2::DavCollection::List collections) = 0;
/**
* Called when discovering a new item, or when an item has been modified.
* It's purpose should be adding the said item to the store.
*
* `collectionLocalRid` is the local resource id of the collection the item
* is in.
*/
virtual void updateLocalItem(KDAV2::DavItem item, const QByteArray &collectionLocalRid) = 0;
/**
* Get the local resource id from a collection.
*/
virtual QByteArray collectionLocalResourceID(const KDAV2::DavCollection &collection) = 0;
KAsync::Job<void> synchronizeCollection(const KDAV2::DavCollection &,
QSharedPointer<int> progress, QSharedPointer<int> total, QSharedPointer<QSet<QByteArray>> itemsResourceIDs);
KAsync::Job<void> synchronizeItem(const KDAV2::DavItem &, const QByteArray &collectionLocalRid,
QSharedPointer<int> progress, QSharedPointer<int> total);
static QByteArray resourceID(const KDAV2::DavCollection &);
static QByteArray resourceID(const KDAV2::DavItem &);
/**
* Used to get the url of an item / collection with the given remote ID
*/
KDAV2::DavUrl urlOf(const QByteArray &remoteId);
/**
* Used to get the url of an item / collection with the given remote ID,
* and append `itemPath` to the path of the URI.
*
* Useful when adding a new item to a collection
*/
KDAV2::DavUrl urlOf(const QByteArray &collectionRemoteId, const QString &itemPath);
bool unchanged(const KDAV2::DavCollection &);
bool unchanged(const KDAV2::DavItem &);
KDAV2::DavUrl serverUrl() const;
private:
KDAV2::Protocol protocol;
const QByteArray collectionName;
const QByteArray itemName;
QUrl mServer;
QString mUsername;
};
|
