Codebase list mozc / upstream/1.6.1187.102 sync / syncer.cc
upstream/1.6.1187.102

Tree @upstream/1.6.1187.102 (Download .tar.gz)

syncer.cc @upstream/1.6.1187.102raw · history · blame

  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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// Copyright 2010-2012, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "sync/syncer.h"

#include "base/base.h"
#include "base/logging.h"
#include "base/singleton.h"
#include "config/config_handler.h"
#include "storage/registry.h"
#include "sync/adapter_interface.h"
#include "sync/config_adapter.h"
#include "sync/logging.h"
#include "sync/mock_syncer.h"
#include "sync/oauth2_client.h"
#include "sync/oauth2_util.h"
#include "sync/service_interface.h"
#include "sync/user_dictionary_adapter.h"

DEFINE_string(sync_url,
              "",
              "sync url");

namespace mozc {
namespace sync {

using config::Config;
using config::ConfigHandler;
using config::SyncConfig;

namespace {
const int kSyncClientVersion = 1;
const char kLastDownloadTimeStampKey[] = "sync.last_download_timestamp";

bool CheckConfigToSync(const Config &config, const uint32 component_id) {
  if (!config.has_sync_config()) {
    LOG(WARNING) << "CheckConfigToSync() is called without sync_config set.";
    return false;
  }

  // Check config on each sync feature.
  const SyncConfig &sync_config = config.sync_config();
  switch(component_id) {
    case ime_sync::MOZC_SETTING:
      return sync_config.use_config_sync();
    case ime_sync::MOZC_USER_DICTIONARY:
      return sync_config.use_user_dictionary_sync();
    case ime_sync::MOZC_USER_HISTORY_PREDICTION:
      return sync_config.use_user_history_sync();
    case ime_sync::MOZC_LEARNING_PREFERENCE:
      return sync_config.use_learning_preference_sync();
  }

  // Do not sync unkown features.
  return false;
}
}  // anonymous namespace

Syncer::Syncer(ServiceInterface *service)
    : service_(service) {}

Syncer::~Syncer() {}

// This function is not thread safe.
bool Syncer::RegisterAdapter(AdapterInterface *adapter) {
  // Can't add more than one adapter for the same component id.
  if (adapters_.find(adapter->component_id()) != adapters_.end()) {
    LOG(WARNING) << "already regsiterd: " << adapter->component_id();
    return false;
  }
  adapters_.insert(make_pair(adapter->component_id(), adapter));
  return true;
}

bool Syncer::Sync(bool *reload_required) {
  SYNC_VLOG(1) << "start Syncer::Sync";
  if (!Download(reload_required)) {
    SYNC_VLOG(1) << "Download failed";
    return false;
  }

  if (!Upload()) {
    SYNC_VLOG(1)  << "Upload failed";
    return false;
  }

  return true;
}

bool Syncer::Clear() {
  SYNC_VLOG(1) << "start Syncer::Clear";
  if (service_ == NULL) {
    SYNC_VLOG(1) << "service is NULL";
    return false;
  }

  ime_sync::ClearRequest request;
  ime_sync::ClearResponse response;

  request.set_version(kSyncClientVersion);
  request.set_client(ime_sync::MOZC);

  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end();
       ++iter) {
    request.add_components(iter->first);
  }

  SYNC_VLOG(1) << "sending clear RPC call";
  if (!service_->Clear(&request, &response)) {
    SYNC_VLOG(1) << "RPC error";
    return false;
  }

  VLOG(2) << "Request: " << request.DebugString();
  VLOG(2) << "Response: " << response.DebugString();

  if (!response.IsInitialized()) {
    SYNC_VLOG(1) << "response is not initialized";
    return false;
  }

  if (response.error() != ime_sync::SYNC_OK) {
    SYNC_VLOG(1) << "response header is not SYNC_OK";
    return false;
  }

  SYNC_VLOG(1) << "clear is called successfully";

  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end(); ++iter) {
    iter->second->Clear();
  }

  SYNC_VLOG(1) << "initializing LastDownloadTimestamp";
  SetLastDownloadTimestamp(0);

  return true;
}

bool Syncer::Download(bool *reload_required) {
  SYNC_VLOG(1) << "start Syncer::Download";
  DCHECK(reload_required);

  *reload_required = false;

  if (service_ == NULL) {
    LOG(ERROR) << "Service is NULL";
    return false;
  }

  ime_sync::DownloadRequest request;
  ime_sync::DownloadResponse response;

  request.set_version(kSyncClientVersion);
  request.set_client(ime_sync::MOZC);

  // if last_download_timestamp is void, use 0 as an initial value
  const uint64 last_download_timestamp = GetLastDownloadTimestamp();
  request.set_last_download_timestamp(last_download_timestamp);

  SYNC_VLOG(1) << "setting last_download_timestamp=" << last_download_timestamp;

  Config config = ConfigHandler::GetConfig();

  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end();
       ++iter) {
    if (CheckConfigToSync(config, iter->first)) {
      request.add_components(iter->first);
    }
  }

  SYNC_VLOG(1) << "downloading remote items...";
  if (!service_->Download(&request, &response)) {
    SYNC_VLOG(1) << "RPC error";
    return false;
  }

  VLOG(2) << "Request: " << request.DebugString();
  VLOG(2) << "Response: " << response.DebugString();

  if (!response.IsInitialized()) {
    SYNC_VLOG(1) << "response is not initialized";
    return false;
  }

  if (response.error() != ime_sync::SYNC_OK) {
    SYNC_VLOG(1) << "response header is not SYNC_OK";
    return false;
  }

  SYNC_VLOG(1) << "done. remote items are downloaded";

  SYNC_VLOG(1) << "updating local components...";
  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end(); ++iter) {
    if (!CheckConfigToSync(config, iter->first)) {
      continue;
    }
    SYNC_VLOG(1) << "calling SetDownloadedItems: "
                 << iter->second->component_id();
    if (!iter->second->SetDownloadedItems(response.items())) {
      SYNC_VLOG(1) << "SetDownloadedItems failed: "
                   << iter->second->component_id();
      return false;
    }
  }

  SYNC_VLOG(1) << "done. local components are updated";

  // when the size of donloaded items > 0, set *reload_required to be true.
  // TODO(taku): this might not be optimal, as items may contain
  // invalid data.
  *reload_required = response.items().size() > 0;

  SYNC_VLOG(1) << "reload_required=" << *reload_required;
  SYNC_VLOG(1) << "LastDownloadTimestamp is updated from "
               << last_download_timestamp << " to "
               << response.download_timestamp();

  SetLastDownloadTimestamp(response.download_timestamp());

  return true;
}

bool Syncer::Upload() {
  SYNC_VLOG(1) << "start Syncer::Upload";

  if (service_ == NULL) {
    LOG(ERROR) << "Service is NULL";
    return false;
  }

  ime_sync::UploadRequest request;
  ime_sync::UploadResponse response;

  request.set_version(kSyncClientVersion);
  request.set_client(ime_sync::MOZC);

  Config config = ConfigHandler::GetConfig();

  SYNC_VLOG(1) << "collecting local updates...";
  bool result = true;
  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end(); ++iter) {
    if (!CheckConfigToSync(config, iter->first)) {
      continue;
    }
    SYNC_VLOG(1) << "calling GetItemsToUpload: "
                 << iter->second->component_id();
    if (!iter->second->GetItemsToUpload(request.mutable_items())) {
      SYNC_VLOG(1) << "GetItemsToUpload failed: "
                   << iter->second->component_id();
      result = false;
    }
  }

  if (request.items_size() == 0) {
    SYNC_VLOG(1) << "no items should be uploaded";
    return true;
  }

  if (result) {
    SYNC_VLOG(1) << "uploading local items to the server...";
    if (!service_->Upload(&request, &response)) {
      SYNC_VLOG(1) << "RPC error";
      result = false;
    }

    VLOG(2) << "Request: " << request.DebugString();
    VLOG(2) << "Response: " << response.DebugString();

    if (response.error() != ime_sync::SYNC_OK) {
      SYNC_VLOG(1) << "response header is not SYNC_OK";
      result = false;
    }

    SYNC_VLOG(1) << "done. local items are uploaded";
  }

  SYNC_VLOG(1) << "marking uploaded flags...";
  for (size_t i = 0; i < request.items_size(); ++i) {
    const ime_sync::SyncItem& item = request.items(i);
    AdapterMap::const_iterator iter = adapters_.find(item.component());
    if (iter == adapters_.end() ||
        !CheckConfigToSync(config, iter->first)) {
      continue;
    }
    // set result code.
    SYNC_VLOG(1) << "calling MarkUploaded: " << iter->second->component_id()
                 << " result=" << result;
    iter->second->MarkUploaded(item, result);
  }

  SYNC_VLOG(1) << "done. uploaded flags";

  return result;
}

bool Syncer::Start() {
  VLOG(1) << "start Syncer::Start()";

  for (AdapterMap::const_iterator iter = adapters_.begin();
       iter != adapters_.end();  ++iter) {
    if (!iter->second->Start()) {
      return false;
    }
  }

  return true;
}

uint64 Syncer::GetLastDownloadTimestamp() const {
  uint64 value = 0;
  if (!mozc::storage::Registry::Lookup(kLastDownloadTimeStampKey, &value)) {
    SYNC_VLOG(1) << "cannot read: " << kLastDownloadTimeStampKey;
  }
  VLOG(1) << "GetLastDownloadTimestamp: " << value;
  return value;
}

void Syncer::SetLastDownloadTimestamp(uint64 value) {
  VLOG(1) << "SetLastDownloadTimestamp: " << value;
  if (!mozc::storage::Registry::Insert(kLastDownloadTimeStampKey, value)) {
    SYNC_VLOG(1) << "cannot save: "<< kLastDownloadTimeStampKey;
  }
  mozc::storage::Registry::Sync();
}

namespace {
SyncerInterface *g_syncer = NULL;
OAuth2Util *g_oauth2 = NULL;

class DefaultSyncerCreator {
 public:
  DefaultSyncerCreator()
      : config_adapter_(new ConfigAdapter),
        user_dictionary_adapter_(new UserDictionaryAdapter) {
    if (g_oauth2 == NULL) {
      SYNC_VLOG(1) << "set oauth2 service";
      SyncerFactory::SetOAuth2(
          new OAuth2Util(OAuth2Client::GetDefaultClient()));
    }

    syncer_.reset(new Syncer(service_.get()));
    if (!syncer_->RegisterAdapter(config_adapter_.get())) {
      SYNC_VLOG(1) << "cannot register ConfigAdapter";
    }

    if (!syncer_->RegisterAdapter(user_dictionary_adapter_.get())) {
      SYNC_VLOG(1) << "cannot register UserDictionaryAdapter";
    }
  }

  SyncerInterface *Get() {
    return syncer_.get();
  }

 private:
  scoped_ptr<ServiceInterface>          service_;
  scoped_ptr<Syncer>                    syncer_;
  scoped_ptr<ConfigAdapter>             config_adapter_;
  scoped_ptr<UserDictionaryAdapter>     user_dictionary_adapter_;
};
}

SyncerInterface *SyncerFactory::GetSyncer() {
  if (g_syncer == NULL) {
    return Singleton<MockSyncer>::get();
  } else {
    return g_syncer;
  }
}

void SyncerFactory::SetSyncer(SyncerInterface *syncer) {
  g_syncer = syncer;
}

void SyncerFactory::SetOAuth2(OAuth2Util *oauth2) {
  g_oauth2 = oauth2;
}
}  // namespace sync
}  // namespace mozc