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
|
// 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.
#include "sync/engine/download_updates_command.h"
#include <string>
#include "base/command_line.h"
#include "sync/engine/syncer.h"
#include "sync/engine/syncer_proto_util.h"
#include "sync/internal_api/public/base/model_type_invalidation_map.h"
#include "sync/sessions/nudge_tracker.h"
#include "sync/syncable/directory.h"
#include "sync/syncable/nigori_handler.h"
#include "sync/syncable/syncable_read_transaction.h"
using sync_pb::DebugInfo;
namespace syncer {
using sessions::StatusController;
using sessions::SyncSession;
using std::string;
DownloadUpdatesCommand::DownloadUpdatesCommand(
bool create_mobile_bookmarks_folder)
: create_mobile_bookmarks_folder_(create_mobile_bookmarks_folder) {}
DownloadUpdatesCommand::~DownloadUpdatesCommand() {}
namespace {
SyncerError HandleGetEncryptionKeyResponse(
const sync_pb::ClientToServerResponse& update_response,
syncable::Directory* dir) {
bool success = false;
if (update_response.get_updates().encryption_keys_size() == 0) {
LOG(ERROR) << "Failed to receive encryption key from server.";
return SERVER_RESPONSE_VALIDATION_FAILED;
}
syncable::ReadTransaction trans(FROM_HERE, dir);
syncable::NigoriHandler* nigori_handler = dir->GetNigoriHandler();
success = nigori_handler->SetKeystoreKeys(
update_response.get_updates().encryption_keys(),
&trans);
DVLOG(1) << "GetUpdates returned "
<< update_response.get_updates().encryption_keys_size()
<< "encryption keys. Nigori keystore key "
<< (success ? "" : "not ") << "updated.";
return (success ? SYNCER_OK : SERVER_RESPONSE_VALIDATION_FAILED);
}
sync_pb::SyncEnums::GetUpdatesOrigin ConvertGetUpdateSourceToOrigin(
sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source) {
switch (source) {
// Configurations:
case sync_pb::GetUpdatesCallerInfo::NEWLY_SUPPORTED_DATATYPE:
return sync_pb::SyncEnums::NEWLY_SUPPORTED_DATATYPE;
case sync_pb::GetUpdatesCallerInfo::MIGRATION:
return sync_pb::SyncEnums::MIGRATION;
case sync_pb::GetUpdatesCallerInfo::RECONFIGURATION:
return sync_pb::SyncEnums::RECONFIGURATION;
case sync_pb::GetUpdatesCallerInfo::NEW_CLIENT:
return sync_pb::SyncEnums::NEW_CLIENT;
// Poll, which never overlaps with anything else:
case sync_pb::GetUpdatesCallerInfo::PERIODIC:
return sync_pb::SyncEnums::PERIODIC;
// Overlapping normal-mode sources (fall-through is intentional):
case sync_pb::GetUpdatesCallerInfo::LOCAL:
case sync_pb::GetUpdatesCallerInfo::NOTIFICATION:
case sync_pb::GetUpdatesCallerInfo::DATATYPE_REFRESH:
return sync_pb::SyncEnums::GU_TRIGGER;
// Deprecated or invalid (fall-through is intentional):
case sync_pb::GetUpdatesCallerInfo::UNKNOWN:
case sync_pb::GetUpdatesCallerInfo::FIRST_UPDATE:
case sync_pb::GetUpdatesCallerInfo::SYNC_CYCLE_CONTINUATION:
NOTREACHED() << "Invalid source: " << source;
return sync_pb::SyncEnums::UNKNOWN_ORIGIN;
}
NOTREACHED();
return sync_pb::SyncEnums::UNKNOWN_ORIGIN;
}
} // namespace
SyncerError DownloadUpdatesCommand::ExecuteImpl(SyncSession* session) {
sync_pb::ClientToServerMessage client_to_server_message;
sync_pb::ClientToServerResponse update_response;
client_to_server_message.set_share(session->context()->account_name());
client_to_server_message.set_message_contents(
sync_pb::ClientToServerMessage::GET_UPDATES);
sync_pb::GetUpdatesMessage* get_updates =
client_to_server_message.mutable_get_updates();
get_updates->set_create_mobile_bookmarks_folder(
create_mobile_bookmarks_folder_);
sync_pb::SyncEnums::GetUpdatesOrigin origin =
ConvertGetUpdateSourceToOrigin(session->source().updates_source);
syncable::Directory* dir = session->context()->directory();
// Request updates for all enabled types.
const ModelTypeSet enabled_types =
GetRoutingInfoTypes(session->context()->routing_info());
DVLOG(1) << "Getting updates for types "
<< ModelTypeSetToString(enabled_types);
DCHECK(!enabled_types.Empty());
const ModelTypeInvalidationMap& invalidation_map =
session->source().types;
for (ModelTypeSet::Iterator it = enabled_types.First();
it.Good(); it.Inc()) {
if (ProxyTypes().Has(it.Get()))
continue;
sync_pb::DataTypeProgressMarker* progress_marker =
get_updates->add_from_progress_marker();
dir->GetDownloadProgress(it.Get(), progress_marker);
// Set notification hint if present.
ModelTypeInvalidationMap::const_iterator find_it =
invalidation_map.find(it.Get());
if (find_it != invalidation_map.end()) {
progress_marker->set_notification_hint(find_it->second.payload);
}
if (origin == sync_pb::SyncEnums::GU_TRIGGER) {
session->nudge_tracker()->FillProtoMessage(
it.Get(),
progress_marker->mutable_get_update_triggers());
} else {
DCHECK(!session->nudge_tracker());
}
}
bool need_encryption_key = false;
if (session->context()->keystore_encryption_enabled()) {
syncable::Directory* dir = session->context()->directory();
syncable::ReadTransaction trans(FROM_HERE, dir);
syncable::NigoriHandler* nigori_handler = dir->GetNigoriHandler();
need_encryption_key = nigori_handler->NeedKeystoreKey(&trans);
get_updates->set_need_encryption_key(need_encryption_key);
}
// We want folders for our associated types, always. If we were to set
// this to false, the server would send just the non-container items
// (e.g. Bookmark URLs but not their containing folders).
get_updates->set_fetch_folders(true);
// Set GetUpdatesMessage.GetUpdatesCallerInfo information.
get_updates->mutable_caller_info()->set_source(
session->source().updates_source);
get_updates->mutable_caller_info()->set_notifications_enabled(
session->context()->notifications_enabled());
// Set the new and improved version of source, too.
get_updates->set_get_updates_origin(origin);
DebugInfo* debug_info = client_to_server_message.mutable_debug_info();
AppendClientDebugInfoIfNeeded(session, debug_info);
SyncerError result = SyncerProtoUtil::PostClientToServerMessage(
&client_to_server_message,
&update_response,
session);
DVLOG(2) << SyncerProtoUtil::ClientToServerResponseDebugString(
update_response);
StatusController* status = session->mutable_status_controller();
status->set_updates_request_types(enabled_types);
if (result != SYNCER_OK) {
status->mutable_updates_response()->Clear();
LOG(ERROR) << "PostClientToServerMessage() failed during GetUpdates";
return result;
}
status->mutable_updates_response()->CopyFrom(update_response);
DVLOG(1) << "GetUpdates "
<< " returned " << update_response.get_updates().entries_size()
<< " updates and indicated "
<< update_response.get_updates().changes_remaining()
<< " updates left on server.";
if (need_encryption_key ||
update_response.get_updates().encryption_keys_size() > 0) {
status->set_last_get_key_result(
HandleGetEncryptionKeyResponse(update_response, dir));
}
return result;
}
void DownloadUpdatesCommand::AppendClientDebugInfoIfNeeded(
sessions::SyncSession* session,
DebugInfo* debug_info) {
// We want to send the debug info only once per sync cycle. Check if it has
// already been sent.
if (!session->status_controller().debug_info_sent()) {
DVLOG(1) << "Sending client debug info ...";
// could be null in some unit tests.
if (session->context()->debug_info_getter()) {
session->context()->debug_info_getter()->GetAndClearDebugInfo(
debug_info);
}
session->mutable_status_controller()->set_debug_info_sent();
}
}
} // namespace syncer
|
