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
|
// 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_ENGINE_PROCESS_COMMIT_RESPONSE_COMMAND_H_
#define SYNC_ENGINE_PROCESS_COMMIT_RESPONSE_COMMAND_H_
#include <set>
#include <string>
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "sync/base/sync_export.h"
#include "sync/engine/model_changing_syncer_command.h"
#include "sync/protocol/sync.pb.h"
namespace syncer {
namespace sessions {
class OrderedCommitSet;
}
namespace syncable {
class Id;
class WriteTransaction;
class MutableEntry;
class Directory;
}
// A class that processes the server's response to our commmit attempt. Note
// that some of the preliminary processing is performed in
// PostClientToServerMessage command.
//
// As part of processing the commit response, this command will modify sync
// entries. It can rename items, update their versions, etc.
//
// This command will return a non-SYNCER_OK value if an error occurred while
// processing the response, or if the server's response indicates that it had
// trouble processing the request.
//
// See SyncerCommand documentation for more info.
class SYNC_EXPORT_PRIVATE ProcessCommitResponseCommand
: public ModelChangingSyncerCommand {
public:
// The commit_set parameter contains references to all the items which were
// to be committed in this batch.
//
// The commmit_message parameter contains the message that was sent to the
// server.
//
// The commit_response parameter contains the response received from the
// server. This may be uninitialized if we were unable to contact the server
// or a serious error was encountered.
ProcessCommitResponseCommand(
const sessions::OrderedCommitSet& commit_set,
const sync_pb::ClientToServerMessage& commit_message,
const sync_pb::ClientToServerResponse& commit_response);
virtual ~ProcessCommitResponseCommand();
protected:
// ModelChangingSyncerCommand implementation.
virtual std::set<ModelSafeGroup> GetGroupsToChange(
const sessions::SyncSession& session) const OVERRIDE;
virtual SyncerError ModelChangingExecuteImpl(
sessions::SyncSession* session) OVERRIDE;
private:
sync_pb::CommitResponse::ResponseType ProcessSingleCommitResponse(
syncable::WriteTransaction* trans,
const sync_pb::CommitResponse_EntryResponse& pb_commit_response,
const sync_pb::SyncEntity& pb_committed_entry,
const syncable::Id& pre_commit_id,
std::set<syncable::Id>* deleted_folders);
// Actually does the work of execute.
SyncerError ProcessCommitResponse(sessions::SyncSession* session);
void ProcessSuccessfulCommitResponse(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id, syncable::MutableEntry* local_entry,
bool syncing_was_set, std::set<syncable::Id>* deleted_folders);
// Update the BASE_VERSION and SERVER_VERSION, post-commit.
// Helper for ProcessSuccessfulCommitResponse.
bool UpdateVersionAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id,
syncable::MutableEntry* local_entry);
// If the server generated an ID for us during a commit, apply the new ID.
// Helper for ProcessSuccessfulCommitResponse.
bool ChangeIdAfterCommit(
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id,
syncable::MutableEntry* local_entry);
// Update the SERVER_ fields to reflect the server state after committing.
// Helper for ProcessSuccessfulCommitResponse.
void UpdateServerFieldsAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
syncable::MutableEntry* local_entry);
// The server can override some values during a commit; the overridden values
// are returned as fields in the CommitResponse_EntryResponse. This method
// stores the fields back in the client-visible (i.e. not the SERVER_* fields)
// fields of the entry. This should only be done if the item did not change
// locally while the commit was in flight.
// Helper for ProcessSuccessfulCommitResponse.
void OverrideClientFieldsAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
syncable::MutableEntry* local_entry);
// Helper to extract the final name from the protobufs.
const std::string& GetResultingPostCommitName(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response);
// Helper to clean up in case of failure.
void ClearSyncingBits(
syncable::Directory *dir,
const std::vector<syncable::Id>& commit_ids);
const sessions::OrderedCommitSet& commit_set_;
const sync_pb::ClientToServerMessage& commit_message_;
const sync_pb::ClientToServerResponse& commit_response_;
DISALLOW_COPY_AND_ASSIGN(ProcessCommitResponseCommand);
};
} // namespace syncer
#endif // SYNC_ENGINE_PROCESS_COMMIT_RESPONSE_COMMAND_H_
|
