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
|
// Copyright 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef SYNC_API_SYNC_DATA_H_
#define SYNC_API_SYNC_DATA_H_
#include <stdint.h>
#include <iosfwd>
#include <string>
#include <vector>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/stl_util.h"
#include "base/time/time.h"
#include "sync/api/attachments/attachment_id.h"
#include "sync/base/sync_export.h"
#include "sync/internal_api/public/attachments/attachment_service_proxy.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/util/immutable.h"
#include "sync/internal_api/public/util/weak_handle.h"
namespace sync_pb {
class EntitySpecifics;
class SyncEntity;
} // namespace sync_pb
namespace syncer {
class AttachmentService;
class SyncDataLocal;
class SyncDataRemote;
// A light-weight container for immutable sync data. Pass-by-value and storage
// in STL containers are supported and encouraged if helpful.
class SYNC_EXPORT SyncData {
public:
// Creates an empty and invalid SyncData.
SyncData();
SyncData(const SyncData& other);
~SyncData();
// Default copy and assign welcome.
// Helper methods for creating SyncData objects for local data.
//
// |sync_tag| Must be a string unique to this datatype and is used as a node
// identifier server-side.
//
// For deletes: |datatype| must specify the datatype who node is being
// deleted.
//
// For adds/updates: |specifics| must be valid and |non_unique_title| (can be
// the same as |sync_tag|) must be specfied. Note: |non_unique_title| is
// primarily for debug purposes, and will be overwritten if the datatype is
// encrypted.
//
// For data with attachments: |attachment_ids| must not contain duplicates.
static SyncData CreateLocalDelete(
const std::string& sync_tag,
ModelType datatype);
static SyncData CreateLocalData(
const std::string& sync_tag,
const std::string& non_unique_title,
const sync_pb::EntitySpecifics& specifics);
static SyncData CreateLocalDataWithAttachments(
const std::string& sync_tag,
const std::string& non_unique_title,
const sync_pb::EntitySpecifics& specifics,
const AttachmentIdList& attachment_ids);
// Helper method for creating SyncData objects originating from the syncer.
static SyncData CreateRemoteData(
int64_t id,
const sync_pb::EntitySpecifics& specifics,
const base::Time& last_modified_time,
const AttachmentIdList& attachment_ids,
const syncer::AttachmentServiceProxy& attachment_service);
// Whether this SyncData holds valid data. The only way to have a SyncData
// without valid data is to use the default constructor.
bool IsValid() const;
// Return the datatype we're holding information about. Derived from the sync
// datatype specifics.
ModelType GetDataType() const;
// Return the current sync datatype specifics.
const sync_pb::EntitySpecifics& GetSpecifics() const;
// Return the non unique title (for debugging). Currently only set for data
// going TO the syncer, not from.
const std::string& GetTitle() const;
// Whether this sync data is for local data or data coming from the syncer.
bool IsLocal() const;
std::string ToString() const;
// Return a list of this SyncData's attachment ids.
//
// The attachments may or may not be present on this device.
AttachmentIdList GetAttachmentIds() const;
// TODO(zea): Query methods for other sync properties: parent, successor, etc.
protected:
// These data members are protected so derived types like SyncDataLocal and
// SyncDataRemote can access them.
// Necessary since we forward-declare sync_pb::SyncEntity; see
// comments in immutable.h.
struct SYNC_EXPORT ImmutableSyncEntityTraits {
typedef sync_pb::SyncEntity* Wrapper;
static void InitializeWrapper(Wrapper* wrapper);
static void DestroyWrapper(Wrapper* wrapper);
static const sync_pb::SyncEntity& Unwrap(const Wrapper& wrapper);
static sync_pb::SyncEntity* UnwrapMutable(Wrapper* wrapper);
static void Swap(sync_pb::SyncEntity* t1, sync_pb::SyncEntity* t2);
};
typedef Immutable<sync_pb::SyncEntity, ImmutableSyncEntityTraits>
ImmutableSyncEntity;
// Equal to kInvalidId iff this is local.
int64_t id_;
// This may be null if the SyncData represents a deleted item.
base::Time remote_modification_time_;
// The actual shared sync entity being held.
ImmutableSyncEntity immutable_entity_;
AttachmentServiceProxy attachment_service_;
private:
// Whether this SyncData holds valid data.
bool is_valid_;
// Clears |entity| and |attachments|.
SyncData(int64_t id,
sync_pb::SyncEntity* entity,
const base::Time& remote_modification_time,
const syncer::AttachmentServiceProxy& attachment_service);
};
// A SyncData going to the syncer.
class SYNC_EXPORT SyncDataLocal : public SyncData {
public:
// Construct a SyncDataLocal from a SyncData.
//
// |sync_data|'s IsLocal() must be true.
explicit SyncDataLocal(const SyncData& sync_data);
~SyncDataLocal();
// Return the value of the unique client tag. This is only set for data going
// TO the syncer, not coming from.
const std::string& GetTag() const;
};
// A SyncData that comes from the syncer.
class SYNC_EXPORT SyncDataRemote : public SyncData {
public:
// Construct a SyncDataRemote from a SyncData.
//
// |sync_data|'s IsLocal() must be false.
explicit SyncDataRemote(const SyncData& sync_data);
~SyncDataRemote();
// Return the last motification time according to the server. This may be null
// if the SyncData represents a deleted item.
const base::Time& GetModifiedTime() const;
int64_t GetId() const;
// Retrieve the attachments indentified by |attachment_ids|. Invoke
// |callback| with the requested attachments.
//
// |callback| will be invoked when the operation is complete (successfully
// or otherwise).
//
// Retrieving the requested attachments may require reading local storage or
// requesting the attachments from the network.
//
void GetOrDownloadAttachments(
const AttachmentIdList& attachment_ids,
const AttachmentService::GetOrDownloadCallback& callback);
};
// gmock printer helper.
void SYNC_EXPORT PrintTo(const SyncData& sync_data, std::ostream* os);
typedef std::vector<SyncData> SyncDataList;
} // namespace syncer
#endif // SYNC_API_SYNC_DATA_H_
|
