#include <string>
-#include "base/command_line.h"
-#include "sync/engine/process_updates_util.h"
-#include "sync/engine/sync_directory_update_handler.h"
-#include "sync/engine/syncer.h"
#include "sync/engine/syncer_proto_util.h"
-#include "sync/sessions/nudge_tracker.h"
+#include "sync/sessions/sync_session.h"
+#include "sync/sessions/sync_session_context.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;
namespace {
-typedef std::map<ModelType, size_t> TypeToIndexMap;
-
SyncerError HandleGetEncryptionKeyResponse(
const sync_pb::ClientToServerResponse& update_response,
syncable::Directory* dir) {
return (success ? SYNCER_OK : SERVER_RESPONSE_VALIDATION_FAILED);
}
-sync_pb::SyncEnums::GetUpdatesOrigin ConvertConfigureSourceToOrigin(
- 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;
- default:
- NOTREACHED();
- return sync_pb::SyncEnums::UNKNOWN_ORIGIN;
- }
-}
-
bool ShouldRequestEncryptionKey(
SyncSessionContext* context) {
bool need_encryption_key = false;
return need_encryption_key;
}
-void AppendClientDebugInfoIfNeeded(
- 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
+
+namespace download {
-void InitDownloadUpdatesRequest(
+void InitDownloadUpdatesContext(
SyncSession* session,
bool create_mobile_bookmarks_folder,
- sync_pb::ClientToServerMessage* message,
- ModelTypeSet proto_request_types) {
+ sync_pb::ClientToServerMessage* message) {
message->set_share(session->context()->account_name());
message->set_message_contents(sync_pb::ClientToServerMessage::GET_UPDATES);
// (e.g. Bookmark URLs but not their containing folders).
get_updates->set_fetch_folders(true);
- DebugInfo* debug_info = message->mutable_debug_info();
- AppendClientDebugInfoIfNeeded(session, debug_info);
-
get_updates->set_create_mobile_bookmarks_folder(
create_mobile_bookmarks_folder);
bool need_encryption_key = ShouldRequestEncryptionKey(session->context());
// Set legacy GetUpdatesMessage.GetUpdatesCallerInfo information.
get_updates->mutable_caller_info()->set_notifications_enabled(
session->context()->notifications_enabled());
-
- StatusController* status = session->mutable_status_controller();
- status->set_updates_request_types(proto_request_types);
-
- UpdateHandlerMap* handler_map = session->context()->update_handler_map();
-
- for (ModelTypeSet::Iterator it = proto_request_types.First();
- it.Good(); it.Inc()) {
- UpdateHandlerMap::iterator handler_it = handler_map->find(it.Get());
- DCHECK(handler_it != handler_map->end());
- sync_pb::DataTypeProgressMarker* progress_marker =
- get_updates->add_from_progress_marker();
- handler_it->second->GetDownloadProgress(progress_marker);
- }
-}
-
-// Builds a map of ModelTypes to indices to progress markers in the given
-// |gu_response| message. The map is returned in the |index_map| parameter.
-void PartitionProgressMarkersByType(
- const sync_pb::GetUpdatesResponse& gu_response,
- ModelTypeSet request_types,
- TypeToIndexMap* index_map) {
- for (int i = 0; i < gu_response.new_progress_marker_size(); ++i) {
- int field_number = gu_response.new_progress_marker(i).data_type_id();
- ModelType model_type = GetModelTypeFromSpecificsFieldNumber(field_number);
- if (!IsRealDataType(model_type)) {
- DLOG(WARNING) << "Unknown field number " << field_number;
- continue;
- }
- if (!request_types.Has(model_type)) {
- DLOG(WARNING)
- << "Skipping unexpected progress marker for non-enabled type "
- << ModelTypeToString(model_type);
- continue;
- }
- index_map->insert(std::make_pair(model_type, i));
- }
-}
-
-// Examines the contents of the GetUpdates response message and forwards
-// relevant data to the UpdateHandlers for processing and persisting.
-bool ProcessUpdateResponseMessage(
- const sync_pb::GetUpdatesResponse& gu_response,
- ModelTypeSet proto_request_types,
- UpdateHandlerMap* handler_map,
- StatusController* status) {
- TypeSyncEntityMap updates_by_type;
- PartitionUpdatesByType(gu_response, proto_request_types, &updates_by_type);
- DCHECK_EQ(proto_request_types.Size(), updates_by_type.size());
-
- TypeToIndexMap progress_index_by_type;
- PartitionProgressMarkersByType(gu_response,
- proto_request_types,
- &progress_index_by_type);
- if (proto_request_types.Size() != progress_index_by_type.size()) {
- NOTREACHED() << "Missing progress markers in GetUpdates response.";
- return false;
- }
-
- // Iterate over these maps in parallel, processing updates for each type.
- TypeToIndexMap::iterator progress_marker_iter =
- progress_index_by_type.begin();
- TypeSyncEntityMap::iterator updates_iter = updates_by_type.begin();
- for ( ; (progress_marker_iter != progress_index_by_type.end()
- && updates_iter != updates_by_type.end());
- ++progress_marker_iter, ++updates_iter) {
- DCHECK_EQ(progress_marker_iter->first, updates_iter->first);
- ModelType type = progress_marker_iter->first;
-
- UpdateHandlerMap::iterator update_handler_iter = handler_map->find(type);
-
- if (update_handler_iter != handler_map->end()) {
- update_handler_iter->second->ProcessGetUpdatesResponse(
- gu_response.new_progress_marker(progress_marker_iter->second),
- updates_iter->second,
- status);
- } else {
- DLOG(WARNING)
- << "Ignoring received updates of a type we can't handle. "
- << "Type is: " << ModelTypeToString(type);
- continue;
- }
- }
- DCHECK(progress_marker_iter == progress_index_by_type.end()
- && updates_iter == updates_by_type.end());
-
- return true;
-}
-
-} // namespace
-
-void BuildNormalDownloadUpdates(
- SyncSession* session,
- bool create_mobile_bookmarks_folder,
- ModelTypeSet request_types,
- const sessions::NudgeTracker& nudge_tracker,
- sync_pb::ClientToServerMessage* client_to_server_message) {
- InitDownloadUpdatesRequest(
- session,
- create_mobile_bookmarks_folder,
- client_to_server_message,
- Intersection(request_types, ProtocolTypes()));
- sync_pb::GetUpdatesMessage* get_updates =
- client_to_server_message->mutable_get_updates();
-
- // Request updates for all requested types.
- DVLOG(1) << "Getting updates for types "
- << ModelTypeSetToString(request_types);
- DCHECK(!request_types.Empty());
-
- // Set legacy GetUpdatesMessage.GetUpdatesCallerInfo information.
- get_updates->mutable_caller_info()->set_source(
- nudge_tracker.updates_source());
-
- // Set the new and improved version of source, too.
- get_updates->set_get_updates_origin(sync_pb::SyncEnums::GU_TRIGGER);
-
- // Fill in the notification hints.
- for (int i = 0; i < get_updates->from_progress_marker_size(); ++i) {
- sync_pb::DataTypeProgressMarker* progress_marker =
- get_updates->mutable_from_progress_marker(i);
- ModelType type = GetModelTypeFromSpecificsFieldNumber(
- progress_marker->data_type_id());
-
- DCHECK(!nudge_tracker.IsTypeThrottled(type))
- << "Throttled types should have been removed from the request_types.";
-
- nudge_tracker.SetLegacyNotificationHint(type, progress_marker);
- nudge_tracker.FillProtoMessage(
- type,
- progress_marker->mutable_get_update_triggers());
- }
-}
-
-void BuildDownloadUpdatesForConfigure(
- SyncSession* session,
- bool create_mobile_bookmarks_folder,
- sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source,
- ModelTypeSet request_types,
- sync_pb::ClientToServerMessage* client_to_server_message) {
- InitDownloadUpdatesRequest(
- session,
- create_mobile_bookmarks_folder,
- client_to_server_message,
- Intersection(request_types, ProtocolTypes()));
- sync_pb::GetUpdatesMessage* get_updates =
- client_to_server_message->mutable_get_updates();
-
- // Request updates for all enabled types.
- DVLOG(1) << "Initial download for types "
- << ModelTypeSetToString(request_types);
- DCHECK(!request_types.Empty());
-
- // Set legacy GetUpdatesMessage.GetUpdatesCallerInfo information.
- get_updates->mutable_caller_info()->set_source(source);
-
- // Set the new and improved version of source, too.
- sync_pb::SyncEnums::GetUpdatesOrigin origin =
- ConvertConfigureSourceToOrigin(source);
- get_updates->set_get_updates_origin(origin);
-}
-
-void BuildDownloadUpdatesForPoll(
- SyncSession* session,
- bool create_mobile_bookmarks_folder,
- ModelTypeSet request_types,
- sync_pb::ClientToServerMessage* client_to_server_message) {
- InitDownloadUpdatesRequest(
- session,
- create_mobile_bookmarks_folder,
- client_to_server_message,
- Intersection(request_types, ProtocolTypes()));
- sync_pb::GetUpdatesMessage* get_updates =
- client_to_server_message->mutable_get_updates();
-
- DVLOG(1) << "Polling for types "
- << ModelTypeSetToString(request_types);
- DCHECK(!request_types.Empty());
-
- // Set legacy GetUpdatesMessage.GetUpdatesCallerInfo information.
- get_updates->mutable_caller_info()->set_source(
- sync_pb::GetUpdatesCallerInfo::PERIODIC);
-
- // Set the new and improved version of source, too.
- get_updates->set_get_updates_origin(sync_pb::SyncEnums::PERIODIC);
}
SyncerError ExecuteDownloadUpdates(
ModelTypeSet request_types,
SyncSession* session,
+ GetUpdatesProcessor* get_updates_processor,
sync_pb::ClientToServerMessage* msg) {
sync_pb::ClientToServerResponse update_response;
StatusController* status = session->mutable_status_controller();
bool need_encryption_key = ShouldRequestEncryptionKey(session->context());
+ if (session->context()->debug_info_getter()) {
+ sync_pb::DebugInfo* debug_info = msg->mutable_debug_info();
+ CopyClientDebugInfo(session->context()->debug_info_getter(), debug_info);
+ }
+
SyncerError result = SyncerProtoUtil::PostClientToServerMessage(
msg,
&update_response,
update_response);
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 (session->context()->debug_info_getter()) {
+ // Clear debug info now that we have successfully sent it to the server.
+ DVLOG(1) << "Clearing client debug info.";
+ session->context()->debug_info_getter()->ClearDebugInfo();
+ }
+
if (need_encryption_key ||
update_response.get_updates().encryption_keys_size() > 0) {
syncable::Directory* dir = session->context()->directory();
HandleGetEncryptionKeyResponse(update_response, dir));
}
- const sync_pb::GetUpdatesResponse& gu_response =
- update_response.get_updates();
+ return ProcessResponse(update_response.get_updates(),
+ request_types,
+ get_updates_processor,
+ status);
+}
+
+SyncerError ProcessResponse(
+ const sync_pb::GetUpdatesResponse& gu_response,
+ ModelTypeSet request_types,
+ GetUpdatesProcessor* get_updates_processor,
+ StatusController* status) {
status->increment_num_updates_downloaded_by(gu_response.entries_size());
- DCHECK(gu_response.has_changes_remaining());
+
+ // The changes remaining field is used to prevent the client from looping. If
+ // that field is being set incorrectly, we're in big trouble.
+ if (!gu_response.has_changes_remaining()) {
+ return SERVER_RESPONSE_VALIDATION_FAILED;
+ }
status->set_num_server_changes_remaining(gu_response.changes_remaining());
- const ModelTypeSet proto_request_types =
- Intersection(request_types, ProtocolTypes());
- if (!ProcessUpdateResponseMessage(gu_response,
- proto_request_types,
- session->context()->update_handler_map(),
- status)) {
+ if (!get_updates_processor->ProcessGetUpdatesResponse(request_types,
+ gu_response,
+ status)) {
return SERVER_RESPONSE_VALIDATION_FAILED;
+ }
+
+ if (gu_response.changes_remaining() == 0) {
+ return SYNCER_OK;
} else {
- return result;
+ return SERVER_MORE_TO_DOWNLOAD;
}
}
+void CopyClientDebugInfo(
+ sessions::DebugInfoGetter* debug_info_getter,
+ sync_pb::DebugInfo* debug_info) {
+ DVLOG(1) << "Copying client debug info to send.";
+ debug_info_getter->GetDebugInfo(debug_info);
+}
+
+} // namespace download
+
} // namespace syncer
projects / platform / framework / web / crosswalk.git / blobdiff