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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
|
// Copyright (c) 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 "build/build_config.h"
#include "chrome/browser/sync/glue/sync_backend_host.h"
#include <algorithm>
#include <map>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/compiler_specific.h"
#include "base/file_path.h"
#include "base/file_util.h"
#include "base/location.h"
#include "base/metrics/histogram.h"
#include "base/threading/sequenced_worker_pool.h"
#include "base/threading/thread_restrictions.h"
#include "base/timer.h"
#include "base/tracked_objects.h"
#include "base/utf_string_conversions.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/signin/token_service.h"
#include "chrome/browser/sync/glue/bridged_sync_notifier.h"
#include "chrome/browser/sync/glue/change_processor.h"
#include "chrome/browser/sync/glue/chrome_encryptor.h"
#include "chrome/browser/sync/glue/sync_backend_registrar.h"
#include "chrome/browser/sync/invalidations/invalidator_storage.h"
#include "chrome/browser/sync/sync_prefs.h"
#include "chrome/common/chrome_notification_types.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/chrome_version_info.h"
#include "chrome/common/net/gaia/gaia_constants.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/notification_service.h"
#include "content/public/common/content_client.h"
#include "jingle/notifier/base/notification_method.h"
#include "jingle/notifier/base/notifier_options.h"
#include "net/base/host_port_pair.h"
#include "net/url_request/url_request_context_getter.h"
#include "sync/internal_api/public/base_transaction.h"
#include "sync/internal_api/public/engine/model_safe_worker.h"
#include "sync/internal_api/public/http_bridge.h"
#include "sync/internal_api/public/read_transaction.h"
#include "sync/internal_api/public/util/experiments.h"
#include "sync/notifier/sync_notifier.h"
#include "sync/protocol/encryption.pb.h"
#include "sync/protocol/sync.pb.h"
#include "sync/util/nigori.h"
static const int kSaveChangesIntervalSeconds = 10;
static const FilePath::CharType kSyncDataFolderName[] =
FILE_PATH_LITERAL("Sync Data");
typedef TokenService::TokenAvailableDetails TokenAvailableDetails;
typedef GoogleServiceAuthError AuthError;
namespace browser_sync {
using content::BrowserThread;
using csync::sessions::SyncSessionSnapshot;
using csync::SyncCredentials;
// Helper macros to log with the syncer thread name; useful when there
// are multiple syncers involved.
#define SLOG(severity) LOG(severity) << name_ << ": "
#define SDVLOG(verbose_level) DVLOG(verbose_level) << name_ << ": "
class SyncBackendHost::Core
: public base::RefCountedThreadSafe<SyncBackendHost::Core>,
public csync::SyncManager::Observer {
public:
Core(const std::string& name,
const FilePath& sync_data_folder_path,
const base::WeakPtr<SyncBackendHost>& backend);
// SyncManager::Observer implementation. The Core just acts like an air
// traffic controller here, forwarding incoming messages to appropriate
// landing threads.
virtual void OnSyncCycleCompleted(
const csync::sessions::SyncSessionSnapshot& snapshot) OVERRIDE;
virtual void OnInitializationComplete(
const csync::WeakHandle<csync::JsBackend>& js_backend,
bool success) OVERRIDE;
virtual void OnConnectionStatusChange(
csync::ConnectionStatus status) OVERRIDE;
virtual void OnPassphraseRequired(
csync::PassphraseRequiredReason reason,
const sync_pb::EncryptedData& pending_keys) OVERRIDE;
virtual void OnPassphraseAccepted() OVERRIDE;
virtual void OnBootstrapTokenUpdated(
const std::string& bootstrap_token) OVERRIDE;
virtual void OnStopSyncingPermanently() OVERRIDE;
virtual void OnUpdatedToken(const std::string& token) OVERRIDE;
virtual void OnEncryptedTypesChanged(
syncable::ModelTypeSet encrypted_types,
bool encrypt_everything) OVERRIDE;
virtual void OnEncryptionComplete() OVERRIDE;
virtual void OnActionableError(
const csync::SyncProtocolError& sync_error) OVERRIDE;
// Note:
//
// The Do* methods are the various entry points from our
// SyncBackendHost. They are all called on the sync thread to
// actually perform synchronous (and potentially blocking) syncapi
// operations.
//
// Called to perform initialization of the syncapi on behalf of
// SyncBackendHost::Initialize.
void DoInitialize(const DoInitializeOptions& options);
// Called to perform credential update on behalf of
// SyncBackendHost::UpdateCredentials
void DoUpdateCredentials(const csync::SyncCredentials& credentials);
// Called when the user disables or enables a sync type.
void DoUpdateEnabledTypes(const syncable::ModelTypeSet& enabled_types);
// Called to tell the syncapi to start syncing (generally after
// initialization and authentication).
void DoStartSyncing(const csync::ModelSafeRoutingInfo& routing_info);
// Called to cleanup disabled types.
void DoRequestCleanupDisabledTypes(
const csync::ModelSafeRoutingInfo& routing_info);
// Called to set the passphrase for encryption.
void DoSetEncryptionPassphrase(const std::string& passphrase,
bool is_explicit);
// Called to decrypt the pending keys.
void DoSetDecryptionPassphrase(const std::string& passphrase);
// Called to turn on encryption of all sync data as well as
// reencrypt everything.
void DoEnableEncryptEverything();
// Called to refresh encryption with the most recent passphrase
// and set of encrypted types. Also adds device information to the nigori
// node. |done_callback| is called on the sync thread.
void DoRefreshNigori(const base::Closure& done_callback);
// The shutdown order is a bit complicated:
// 1) From |sync_thread_|, invoke the syncapi Shutdown call to do
// a final SaveChanges, and close sqlite handles.
// 2) Then, from |frontend_loop_|, halt the sync_thread_ (which is
// a blocking call). This causes syncapi thread-exit handlers
// to run and make use of cached pointers to various components
// owned implicitly by us.
// 3) Destroy this Core. That will delete syncapi components in a
// safe order because the thread that was using them has exited
// (in step 2).
void DoStopSyncManagerForShutdown(const base::Closure& closure);
void DoShutdown(bool stopping_sync);
virtual void DoRequestConfig(
const csync::ModelSafeRoutingInfo& routing_info,
syncable::ModelTypeSet types_to_config,
csync::ConfigureReason reason);
// Start the configuration mode. |callback| is called on the sync
// thread.
virtual void DoStartConfiguration(const base::Closure& callback);
// Set the base request context to use when making HTTP calls.
// This method will add a reference to the context to persist it
// on the IO thread. Must be removed from IO thread.
csync::SyncManager* sync_manager() { return sync_manager_.get(); }
// Delete the sync data folder to cleanup backend data. Happens the first
// time sync is enabled for a user (to prevent accidentally reusing old
// sync databases), as well as shutdown when you're no longer syncing.
void DeleteSyncDataFolder();
// A callback from the SyncerThread when it is safe to continue config.
void FinishConfigureDataTypes();
private:
friend class base::RefCountedThreadSafe<SyncBackendHost::Core>;
friend class SyncBackendHostForProfileSyncTest;
virtual ~Core();
// Invoked when initialization of syncapi is complete and we can start
// our timer.
// This must be called from the thread on which SaveChanges is intended to
// be run on; the host's |sync_thread_|.
void StartSavingChanges();
// Invoked periodically to tell the syncapi to persist its state
// by writing to disk.
// This is called from the thread we were created on (which is the
// SyncBackendHost |sync_thread_|), using a repeating timer that is kicked
// off as soon as the SyncManager tells us it completed
// initialization.
void SaveChanges();
// Name used for debugging.
const std::string name_;
// Path of the folder that stores the sync data files.
const FilePath sync_data_folder_path_;
// Our parent SyncBackendHost.
csync::WeakHandle<SyncBackendHost> host_;
// The loop where all the sync backend operations happen.
// Non-NULL only between calls to DoInitialize() and DoShutdown().
MessageLoop* sync_loop_;
// Our parent's registrar (not owned). Non-NULL only between
// calls to DoInitialize() and DoShutdown().
SyncBackendRegistrar* registrar_;
// The timer used to periodically call SaveChanges.
scoped_ptr<base::RepeatingTimer<Core> > save_changes_timer_;
// Our encryptor, which uses Chrome's encryption functions.
ChromeEncryptor encryptor_;
// The top-level syncapi entry point. Lives on the sync thread.
scoped_ptr<csync::SyncManager> sync_manager_;
DISALLOW_COPY_AND_ASSIGN(Core);
};
namespace {
// Parses the given command line for notifier options.
notifier::NotifierOptions ParseNotifierOptions(
const CommandLine& command_line,
const scoped_refptr<net::URLRequestContextGetter>&
request_context_getter) {
notifier::NotifierOptions notifier_options;
notifier_options.request_context_getter = request_context_getter;
if (command_line.HasSwitch(switches::kSyncNotificationHostPort)) {
notifier_options.xmpp_host_port =
net::HostPortPair::FromString(
command_line.GetSwitchValueASCII(
switches::kSyncNotificationHostPort));
DVLOG(1) << "Using " << notifier_options.xmpp_host_port.ToString()
<< " for test sync notification server.";
}
notifier_options.try_ssltcp_first =
command_line.HasSwitch(switches::kSyncTrySsltcpFirstForXmpp);
DVLOG_IF(1, notifier_options.try_ssltcp_first)
<< "Trying SSL/TCP port before XMPP port for notifications.";
notifier_options.invalidate_xmpp_login =
command_line.HasSwitch(switches::kSyncInvalidateXmppLogin);
DVLOG_IF(1, notifier_options.invalidate_xmpp_login)
<< "Invalidating sync XMPP login.";
notifier_options.allow_insecure_connection =
command_line.HasSwitch(switches::kSyncAllowInsecureXmppConnection);
DVLOG_IF(1, notifier_options.allow_insecure_connection)
<< "Allowing insecure XMPP connections.";
if (command_line.HasSwitch(switches::kSyncNotificationMethod)) {
const std::string notification_method_str(
command_line.GetSwitchValueASCII(switches::kSyncNotificationMethod));
notifier_options.notification_method =
notifier::StringToNotificationMethod(notification_method_str);
}
return notifier_options;
}
} // namespace
SyncBackendHost::SyncBackendHost(
const std::string& name,
Profile* profile,
const base::WeakPtr<SyncPrefs>& sync_prefs,
const base::WeakPtr<InvalidatorStorage>& invalidator_storage)
: weak_ptr_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)),
sync_thread_("Chrome_SyncThread"),
frontend_loop_(MessageLoop::current()),
profile_(profile),
name_(name),
core_(new Core(name, profile_->GetPath().Append(kSyncDataFolderName),
weak_ptr_factory_.GetWeakPtr())),
initialization_state_(NOT_ATTEMPTED),
sync_prefs_(sync_prefs),
chrome_sync_notification_bridge_(profile_),
sync_notifier_factory_(
ParseNotifierOptions(*CommandLine::ForCurrentProcess(),
profile_->GetRequestContext()),
content::GetUserAgent(GURL()),
invalidator_storage),
frontend_(NULL) {
}
SyncBackendHost::SyncBackendHost(Profile* profile)
: weak_ptr_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(this)),
sync_thread_("Chrome_SyncThread"),
frontend_loop_(MessageLoop::current()),
profile_(profile),
name_("Unknown"),
initialization_state_(NOT_ATTEMPTED),
chrome_sync_notification_bridge_(profile_),
sync_notifier_factory_(
ParseNotifierOptions(*CommandLine::ForCurrentProcess(),
profile_->GetRequestContext()),
content::GetUserAgent(GURL()),
base::WeakPtr<csync::InvalidationStateTracker>()),
frontend_(NULL) {
}
SyncBackendHost::~SyncBackendHost() {
DCHECK(!core_ && !frontend_) << "Must call Shutdown before destructor.";
DCHECK(!registrar_.get());
}
namespace {
// Helper to construct a user agent string (ASCII) suitable for use by
// the syncapi for any HTTP communication. This string is used by the sync
// backend for classifying client types when calculating statistics.
std::string MakeUserAgentForSyncApi() {
std::string user_agent;
user_agent = "Chrome ";
#if defined(OS_WIN)
user_agent += "WIN ";
#elif defined(OS_CHROMEOS)
user_agent += "CROS ";
#elif defined(OS_LINUX)
user_agent += "LINUX ";
#elif defined(OS_FREEBSD)
user_agent += "FREEBSD ";
#elif defined(OS_OPENBSD)
user_agent += "OPENBSD ";
#elif defined(OS_MACOSX)
user_agent += "MAC ";
#endif
chrome::VersionInfo version_info;
if (!version_info.is_valid()) {
DLOG(ERROR) << "Unable to create chrome::VersionInfo object";
return user_agent;
}
user_agent += version_info.Version();
user_agent += " (" + version_info.LastChange() + ")";
if (!version_info.IsOfficialBuild())
user_agent += "-devel";
return user_agent;
}
csync::HttpPostProviderFactory* MakeHttpBridgeFactory(
const scoped_refptr<net::URLRequestContextGetter>& getter) {
return new HttpBridgeFactory(getter, MakeUserAgentForSyncApi());
}
} // namespace
void SyncBackendHost::Initialize(
SyncFrontend* frontend,
const csync::WeakHandle<csync::JsEventHandler>& event_handler,
const GURL& sync_service_url,
syncable::ModelTypeSet initial_types,
const SyncCredentials& credentials,
bool delete_sync_data_folder,
csync::UnrecoverableErrorHandler* unrecoverable_error_handler,
csync::ReportUnrecoverableErrorFunction
report_unrecoverable_error_function) {
if (!sync_thread_.Start())
return;
frontend_ = frontend;
DCHECK(frontend);
syncable::ModelTypeSet initial_types_with_nigori(initial_types);
CHECK(sync_prefs_.get());
if (sync_prefs_->HasSyncSetupCompleted()) {
initial_types_with_nigori.Put(syncable::NIGORI);
}
registrar_.reset(new SyncBackendRegistrar(initial_types_with_nigori,
name_,
profile_,
sync_thread_.message_loop()));
csync::ModelSafeRoutingInfo routing_info;
std::vector<csync::ModelSafeWorker*> workers;
registrar_->GetModelSafeRoutingInfo(&routing_info);
registrar_->GetWorkers(&workers);
initialization_state_ = CREATING_SYNC_MANAGER;
InitCore(DoInitializeOptions(
sync_thread_.message_loop(),
registrar_.get(),
routing_info,
workers,
&extensions_activity_monitor_,
event_handler,
sync_service_url,
base::Bind(&MakeHttpBridgeFactory,
make_scoped_refptr(profile_->GetRequestContext())),
credentials,
&chrome_sync_notification_bridge_,
&sync_notifier_factory_,
delete_sync_data_folder,
sync_prefs_->GetEncryptionBootstrapToken(),
csync::SyncManager::NON_TEST,
unrecoverable_error_handler,
report_unrecoverable_error_function));
}
void SyncBackendHost::UpdateCredentials(const SyncCredentials& credentials) {
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoUpdateCredentials, core_.get(),
credentials));
}
void SyncBackendHost::StartSyncingWithServer() {
SDVLOG(1) << "SyncBackendHost::StartSyncingWithServer called.";
csync::ModelSafeRoutingInfo routing_info;
registrar_->GetModelSafeRoutingInfo(&routing_info);
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoStartSyncing,
core_.get(), routing_info));
}
void SyncBackendHost::SetEncryptionPassphrase(const std::string& passphrase,
bool is_explicit) {
if (!IsNigoriEnabled()) {
NOTREACHED() << "SetEncryptionPassphrase must never be called when nigori"
" is disabled.";
return;
}
// We should never be called with an empty passphrase.
DCHECK(!passphrase.empty());
// This should only be called by the frontend.
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// SetEncryptionPassphrase should never be called if we are currently
// encrypted with an explicit passphrase.
DCHECK(!IsUsingExplicitPassphrase());
// Post an encryption task on the syncer thread.
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoSetEncryptionPassphrase, core_.get(),
passphrase, is_explicit));
}
bool SyncBackendHost::SetDecryptionPassphrase(const std::string& passphrase) {
if (!IsNigoriEnabled()) {
NOTREACHED() << "SetDecryptionPassphrase must never be called when nigori"
" is disabled.";
return false;
}
// We should never be called with an empty passphrase.
DCHECK(!passphrase.empty());
// This should only be called by the frontend.
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// This should only be called when we have cached pending keys.
DCHECK(cached_pending_keys_.has_blob());
// Check the passphrase that was provided against our local cache of the
// cryptographer's pending keys. If this was unsuccessful, the UI layer can
// immediately call OnPassphraseRequired without showing the user a spinner.
if (!CheckPassphraseAgainstCachedPendingKeys(passphrase))
return false;
// Post a decryption task on the syncer thread.
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoSetDecryptionPassphrase, core_.get(),
passphrase));
// Since we were able to decrypt the cached pending keys with the passphrase
// provided, we immediately alert the UI layer that the passphrase was
// accepted. This will avoid the situation where a user enters a passphrase,
// clicks OK, immediately reopens the advanced settings dialog, and gets an
// unnecessary prompt for a passphrase.
// Note: It is not guaranteed that the passphrase will be accepted by the
// syncer thread, since we could receive a new nigori node while the task is
// pending. This scenario is a valid race, and SetDecryptionPassphrase can
// trigger a new OnPassphraseRequired if it needs to.
NotifyPassphraseAccepted();
return true;
}
void SyncBackendHost::StopSyncManagerForShutdown(
const base::Closure& closure) {
DCHECK_GT(initialization_state_, NOT_ATTEMPTED);
if (initialization_state_ == CREATING_SYNC_MANAGER) {
// We post here to implicitly wait for the SyncManager to be created,
// if needed. We have to wait, since we need to shutdown immediately,
// and we need to tell the SyncManager so it can abort any activity
// (net I/O, data application).
DCHECK(sync_thread_.IsRunning());
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(
&SyncBackendHost::Core::DoStopSyncManagerForShutdown,
core_.get(),
closure));
} else {
core_->DoStopSyncManagerForShutdown(closure);
}
}
void SyncBackendHost::StopSyncingForShutdown() {
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// Thread shutdown should occur in the following order:
// - Sync Thread
// - UI Thread (stops some time after we return from this call).
//
// In order to acheive this, we first shutdown components from the UI thread
// and send signals to abort components that may be busy on the sync thread.
// The callback (OnSyncerShutdownComplete) will happen on the sync thread,
// after which we'll shutdown components on the sync thread, and then be
// able to stop the sync loop.
if (sync_thread_.IsRunning()) {
StopSyncManagerForShutdown(
base::Bind(&SyncBackendRegistrar::OnSyncerShutdownComplete,
base::Unretained(registrar_.get())));
// Before joining the sync_thread_, we wait for the UIModelWorker to
// give us the green light that it is not depending on the frontend_loop_
// to process any more tasks. Stop() blocks until this termination
// condition is true.
base::Time stop_registrar_start_time = base::Time::Now();
if (registrar_.get())
registrar_->StopOnUIThread();
base::TimeDelta stop_registrar_time = base::Time::Now() -
stop_registrar_start_time;
UMA_HISTOGRAM_TIMES("Sync.Shutdown.StopRegistrarTime",
stop_registrar_time);
} else {
// If the sync thread isn't running, then the syncer is effectively
// stopped. Moreover, it implies that we never attempted initialization,
// so the registrar won't need stopping either.
DCHECK_EQ(NOT_ATTEMPTED, initialization_state_);
DCHECK(!registrar_.get());
}
}
void SyncBackendHost::Shutdown(bool sync_disabled) {
// TODO(tim): DCHECK(registrar_->StoppedOnUIThread()) would be nice.
if (sync_thread_.IsRunning()) {
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoShutdown, core_.get(),
sync_disabled));
}
// Stop will return once the thread exits, which will be after DoShutdown
// runs. DoShutdown needs to run from sync_thread_ because the sync backend
// requires any thread that opened sqlite handles to relinquish them
// personally. We need to join threads, because otherwise the main Chrome
// thread (ui loop) can exit before DoShutdown finishes, at which point
// virtually anything the sync backend does (or the post-back to
// frontend_loop_ by our Core) will epically fail because the CRT won't be
// initialized.
// Since we are blocking the UI thread here, we need to turn ourselves in
// with the ThreadRestriction police. For sentencing and how we plan to fix
// this, see bug 19757.
base::Time stop_thread_start_time = base::Time::Now();
{
base::ThreadRestrictions::ScopedAllowIO allow_io;
sync_thread_.Stop();
}
base::TimeDelta stop_sync_thread_time = base::Time::Now() -
stop_thread_start_time;
UMA_HISTOGRAM_TIMES("Sync.Shutdown.StopSyncThreadTime",
stop_sync_thread_time);
registrar_.reset();
frontend_ = NULL;
core_ = NULL; // Releases reference to core_.
}
void SyncBackendHost::ConfigureDataTypes(
csync::ConfigureReason reason,
syncable::ModelTypeSet types_to_add,
syncable::ModelTypeSet types_to_remove,
NigoriState nigori_state,
base::Callback<void(syncable::ModelTypeSet)> ready_task,
base::Callback<void()> retry_callback) {
syncable::ModelTypeSet types_to_add_with_nigori = types_to_add;
syncable::ModelTypeSet types_to_remove_with_nigori = types_to_remove;
if (nigori_state == WITH_NIGORI) {
types_to_add_with_nigori.Put(syncable::NIGORI);
types_to_remove_with_nigori.Remove(syncable::NIGORI);
} else {
types_to_add_with_nigori.Remove(syncable::NIGORI);
types_to_remove_with_nigori.Put(syncable::NIGORI);
}
// Only one configure is allowed at a time.
DCHECK(!pending_config_mode_state_.get());
DCHECK(!pending_download_state_.get());
DCHECK_GT(initialization_state_, NOT_INITIALIZED);
pending_config_mode_state_.reset(new PendingConfigureDataTypesState());
pending_config_mode_state_->ready_task = ready_task;
pending_config_mode_state_->types_to_add = types_to_add_with_nigori;
pending_config_mode_state_->added_types =
registrar_->ConfigureDataTypes(types_to_add_with_nigori,
types_to_remove_with_nigori);
pending_config_mode_state_->reason = reason;
pending_config_mode_state_->retry_callback = retry_callback;
// Cleanup disabled types before starting configuration so that
// callers can assume that the data types are cleaned up once
// configuration is done.
if (!types_to_remove_with_nigori.Empty()) {
csync::ModelSafeRoutingInfo routing_info;
registrar_->GetModelSafeRoutingInfo(&routing_info);
sync_thread_.message_loop()->PostTask(
FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoRequestCleanupDisabledTypes,
core_.get(),
routing_info));
}
StartConfiguration(
base::Bind(&SyncBackendHost::Core::FinishConfigureDataTypes,
core_.get()));
}
void SyncBackendHost::StartConfiguration(const base::Closure& callback) {
// Put syncer in the config mode. DTM will put us in normal mode once it is
// done. This is to ensure we dont do a normal sync when we are doing model
// association.
sync_thread_.message_loop()->PostTask(FROM_HERE, base::Bind(
&SyncBackendHost::Core::DoStartConfiguration, core_.get(), callback));
}
void SyncBackendHost::EnableEncryptEverything() {
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoEnableEncryptEverything,
core_.get()));
}
void SyncBackendHost::ActivateDataType(
syncable::ModelType type, csync::ModelSafeGroup group,
ChangeProcessor* change_processor) {
registrar_->ActivateDataType(type, group, change_processor, GetUserShare());
}
void SyncBackendHost::DeactivateDataType(syncable::ModelType type) {
registrar_->DeactivateDataType(type);
}
csync::UserShare* SyncBackendHost::GetUserShare() const {
DCHECK(initialized());
return core_->sync_manager()->GetUserShare();
}
SyncBackendHost::Status SyncBackendHost::GetDetailedStatus() {
DCHECK(initialized());
return core_->sync_manager()->GetDetailedStatus();
}
SyncSessionSnapshot SyncBackendHost::GetLastSessionSnapshot() const {
return last_snapshot_;
}
bool SyncBackendHost::HasUnsyncedItems() const {
DCHECK(initialized());
return core_->sync_manager()->HasUnsyncedItems();
}
bool SyncBackendHost::IsNigoriEnabled() const {
return registrar_.get() && registrar_->IsNigoriEnabled();
}
bool SyncBackendHost::IsUsingExplicitPassphrase() {
// This should only be called once the nigori node has been downloaded, as
// otherwise we have no idea what kind of passphrase we are using. This will
// NOTREACH in sync_manager and return false if we fail to load the nigori
// node.
return IsNigoriEnabled() &&
core_->sync_manager()->IsUsingExplicitPassphrase();
}
bool SyncBackendHost::IsCryptographerReady(
const csync::BaseTransaction* trans) const {
return initialized() && trans->GetCryptographer()->is_ready();
}
void SyncBackendHost::GetModelSafeRoutingInfo(
csync::ModelSafeRoutingInfo* out) const {
if (initialized()) {
CHECK(registrar_.get());
registrar_->GetModelSafeRoutingInfo(out);
} else {
NOTREACHED();
}
}
void SyncBackendHost::InitCore(const DoInitializeOptions& options) {
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoInitialize, core_.get(), options));
}
void SyncBackendHost::HandleSyncCycleCompletedOnFrontendLoop(
const SyncSessionSnapshot& snapshot) {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
last_snapshot_ = snapshot;
SDVLOG(1) << "Got snapshot " << snapshot.ToString();
const syncable::ModelTypeSet to_migrate =
snapshot.syncer_status().types_needing_local_migration;
if (!to_migrate.Empty())
frontend_->OnMigrationNeededForTypes(to_migrate);
// Process any changes to the datatypes we're syncing.
// TODO(sync): add support for removing types.
if (initialized())
AddExperimentalTypes();
// If we are waiting for a configuration change, check here to see
// if this sync cycle has initialized all of the types we've been
// waiting for.
if (pending_download_state_.get()) {
const syncable::ModelTypeSet types_to_add =
pending_download_state_->types_to_add;
const syncable::ModelTypeSet added_types =
pending_download_state_->added_types;
DCHECK(types_to_add.HasAll(added_types));
const syncable::ModelTypeSet initial_sync_ended =
snapshot.initial_sync_ended();
const syncable::ModelTypeSet failed_configuration_types =
Difference(added_types, initial_sync_ended);
SDVLOG(1)
<< "Added types: "
<< syncable::ModelTypeSetToString(added_types)
<< ", configured types: "
<< syncable::ModelTypeSetToString(initial_sync_ended)
<< ", failed configuration types: "
<< syncable::ModelTypeSetToString(failed_configuration_types);
if (!failed_configuration_types.Empty() &&
snapshot.retry_scheduled()) {
// Inform the caller that download failed but we are retrying.
if (!pending_download_state_->retry_in_progress) {
pending_download_state_->retry_callback.Run();
pending_download_state_->retry_in_progress = true;
}
// Nothing more to do.
return;
}
scoped_ptr<PendingConfigureDataTypesState> state(
pending_download_state_.release());
state->ready_task.Run(failed_configuration_types);
// Syncer did not report an error but did not download everything
// we requested either. So abort. The caller of the config will cleanup.
if (!failed_configuration_types.Empty())
return;
}
if (initialized())
frontend_->OnSyncCycleCompleted();
}
void SyncBackendHost::FinishConfigureDataTypesOnFrontendLoop() {
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// Nudge the syncer. This is necessary for both datatype addition/deletion.
//
// Deletions need a nudge in order to ensure the deletion occurs in a timely
// manner (see issue 56416).
//
// In the case of additions, on the next sync cycle, the syncer should
// notice that the routing info has changed and start the process of
// downloading updates for newly added data types. Once this is
// complete, the configure_state_.ready_task_ is run via an
// OnInitializationComplete notification.
SDVLOG(1) << "Syncer in config mode. SBH executing "
<< "FinishConfigureDataTypesOnFrontendLoop";
csync::ModelSafeRoutingInfo routing_info;
registrar_->GetModelSafeRoutingInfo(&routing_info);
const syncable::ModelTypeSet enabled_types =
GetRoutingInfoTypes(routing_info);
// Update |chrome_sync_notification_bridge_|'s enabled types here as it has
// to happen on the UI thread.
chrome_sync_notification_bridge_.UpdateEnabledTypes(enabled_types);
if (pending_config_mode_state_->added_types.Empty() &&
!core_->sync_manager()->InitialSyncEndedTypes().HasAll(enabled_types)) {
// TODO(tim): Log / UMA / count this somehow?
// Add only the types with empty progress markers. Note: it is possible
// that some types have their initial_sync_ended be false but with non
// empty progress marker. Which is ok as the rest of the changes would
// be downloaded on a regular nudge and initial_sync_ended should be set
// to true. However this is a very corner case. So it is not explicitly
// handled.
pending_config_mode_state_->added_types =
csync::GetTypesWithEmptyProgressMarkerToken(enabled_types,
GetUserShare());
}
// If we've added types, we always want to request a nudge/config (even if
// the initial sync is ended), in case we could not decrypt the data.
if (pending_config_mode_state_->added_types.Empty()) {
SDVLOG(1) << "No new types added; calling ready_task directly";
// No new types - just notify the caller that the types are available.
const syncable::ModelTypeSet failed_configuration_types;
pending_config_mode_state_->ready_task.Run(failed_configuration_types);
} else {
pending_download_state_.reset(pending_config_mode_state_.release());
// Always configure nigori if it's enabled.
syncable::ModelTypeSet types_to_config =
pending_download_state_->added_types;
if (IsNigoriEnabled()) {
// Note: Nigori is the only type that gets added with a nonempty
// progress marker during config. If the server returns a migration
// error then we will go into unrecoverable error. We dont handle it
// explicitly because server might help us out here by not sending a
// migraiton error for nigori during config.
types_to_config.Put(syncable::NIGORI);
}
SDVLOG(1) << "Types "
<< syncable::ModelTypeSetToString(types_to_config)
<< " added; calling DoRequestConfig";
csync::ModelSafeRoutingInfo routing_info;
registrar_->GetModelSafeRoutingInfo(&routing_info);
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoRequestConfig,
core_.get(),
routing_info,
types_to_config,
pending_download_state_->reason));
}
pending_config_mode_state_.reset();
// Notify SyncManager (especially the notification listener) about new types.
sync_thread_.message_loop()->PostTask(FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoUpdateEnabledTypes, core_.get(),
enabled_types));
}
bool SyncBackendHost::IsDownloadingNigoriForTest() const {
return initialization_state_ == DOWNLOADING_NIGORI;
}
SyncBackendHost::DoInitializeOptions::DoInitializeOptions(
MessageLoop* sync_loop,
SyncBackendRegistrar* registrar,
const csync::ModelSafeRoutingInfo& routing_info,
const std::vector<csync::ModelSafeWorker*>& workers,
csync::ExtensionsActivityMonitor* extensions_activity_monitor,
const csync::WeakHandle<csync::JsEventHandler>& event_handler,
const GURL& service_url,
MakeHttpBridgeFactoryFn make_http_bridge_factory_fn,
const csync::SyncCredentials& credentials,
ChromeSyncNotificationBridge* chrome_sync_notification_bridge,
csync::SyncNotifierFactory* sync_notifier_factory,
bool delete_sync_data_folder,
const std::string& restored_key_for_bootstrapping,
csync::SyncManager::TestingMode testing_mode,
csync::UnrecoverableErrorHandler* unrecoverable_error_handler,
csync::ReportUnrecoverableErrorFunction
report_unrecoverable_error_function)
: sync_loop(sync_loop),
registrar(registrar),
routing_info(routing_info),
workers(workers),
extensions_activity_monitor(extensions_activity_monitor),
event_handler(event_handler),
service_url(service_url),
make_http_bridge_factory_fn(make_http_bridge_factory_fn),
credentials(credentials),
chrome_sync_notification_bridge(chrome_sync_notification_bridge),
sync_notifier_factory(sync_notifier_factory),
delete_sync_data_folder(delete_sync_data_folder),
restored_key_for_bootstrapping(restored_key_for_bootstrapping),
testing_mode(testing_mode),
unrecoverable_error_handler(unrecoverable_error_handler),
report_unrecoverable_error_function(
report_unrecoverable_error_function) {
}
SyncBackendHost::DoInitializeOptions::~DoInitializeOptions() {}
SyncBackendHost::Core::Core(const std::string& name,
const FilePath& sync_data_folder_path,
const base::WeakPtr<SyncBackendHost>& backend)
: name_(name),
sync_data_folder_path_(sync_data_folder_path),
host_(backend),
sync_loop_(NULL),
registrar_(NULL) {
DCHECK(backend.get());
}
SyncBackendHost::Core::~Core() {
DCHECK(!sync_manager_.get());
DCHECK(!sync_loop_);
}
SyncBackendHost::PendingConfigureDataTypesState::
PendingConfigureDataTypesState()
: reason(csync::CONFIGURE_REASON_UNKNOWN),
retry_in_progress(false) {}
SyncBackendHost::PendingConfigureDataTypesState::
~PendingConfigureDataTypesState() {}
void SyncBackendHost::Core::OnSyncCycleCompleted(
const SyncSessionSnapshot& snapshot) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::HandleSyncCycleCompletedOnFrontendLoop,
snapshot);
}
void SyncBackendHost::Core::OnInitializationComplete(
const csync::WeakHandle<csync::JsBackend>& js_backend,
bool success) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::HandleInitializationCompletedOnFrontendLoop,
js_backend, success);
if (success) {
// Initialization is complete, so we can schedule recurring SaveChanges.
sync_loop_->PostTask(FROM_HERE,
base::Bind(&Core::StartSavingChanges, this));
}
}
void SyncBackendHost::Core::OnConnectionStatusChange(
csync::ConnectionStatus status) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::HandleConnectionStatusChangeOnFrontendLoop, status);
}
void SyncBackendHost::Core::OnPassphraseRequired(
csync::PassphraseRequiredReason reason,
const sync_pb::EncryptedData& pending_keys) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::NotifyPassphraseRequired, reason, pending_keys);
}
void SyncBackendHost::Core::OnPassphraseAccepted() {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::NotifyPassphraseAccepted);
}
void SyncBackendHost::Core::OnBootstrapTokenUpdated(
const std::string& bootstrap_token) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::PersistEncryptionBootstrapToken, bootstrap_token);
}
void SyncBackendHost::Core::OnStopSyncingPermanently() {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::HandleStopSyncingPermanentlyOnFrontendLoop);
}
void SyncBackendHost::Core::OnUpdatedToken(const std::string& token) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::NotifyUpdatedToken, token);
}
void SyncBackendHost::Core::OnEncryptedTypesChanged(
syncable::ModelTypeSet encrypted_types,
bool encrypt_everything) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
// NOTE: We're in a transaction.
host_.Call(
FROM_HERE,
&SyncBackendHost::NotifyEncryptedTypesChanged,
encrypted_types, encrypt_everything);
}
void SyncBackendHost::Core::OnEncryptionComplete() {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
// NOTE: We're in a transaction.
host_.Call(
FROM_HERE,
&SyncBackendHost::NotifyEncryptionComplete);
}
void SyncBackendHost::Core::OnActionableError(
const csync::SyncProtocolError& sync_error) {
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::HandleActionableErrorEventOnFrontendLoop,
sync_error);
}
void SyncBackendHost::Core::DoInitialize(const DoInitializeOptions& options) {
DCHECK(!sync_loop_);
sync_loop_ = options.sync_loop;
DCHECK(sync_loop_);
// Blow away the partial or corrupt sync data folder before doing any more
// initialization, if necessary.
if (options.delete_sync_data_folder) {
DeleteSyncDataFolder();
}
// Make sure that the directory exists before initializing the backend.
// If it already exists, this will do no harm.
bool success = file_util::CreateDirectory(sync_data_folder_path_);
DCHECK(success);
DCHECK(!registrar_);
registrar_ = options.registrar;
DCHECK(registrar_);
sync_manager_.reset(new csync::SyncManager(name_));
sync_manager_->AddObserver(this);
success = sync_manager_->Init(
sync_data_folder_path_,
options.event_handler,
options.service_url.host() + options.service_url.path(),
options.service_url.EffectiveIntPort(),
options.service_url.SchemeIsSecure(),
BrowserThread::GetBlockingPool(),
options.make_http_bridge_factory_fn.Run(),
options.routing_info,
options.workers,
options.extensions_activity_monitor,
options.registrar /* as SyncManager::ChangeDelegate */,
options.credentials,
new BridgedSyncNotifier(
options.chrome_sync_notification_bridge,
options.sync_notifier_factory->CreateSyncNotifier()),
options.restored_key_for_bootstrapping,
options.testing_mode,
&encryptor_,
options.unrecoverable_error_handler,
options.report_unrecoverable_error_function);
LOG_IF(ERROR, !success) << "Syncapi initialization failed!";
// Now check the command line to see if we need to simulate an
// unrecoverable error for testing purpose. Note the error is thrown
// only if the initialization succeeded. Also it makes sense to use this
// flag only when restarting the browser with an account already setup. If
// you use this before setting up the setup would not succeed as an error
// would be encountered.
if (CommandLine::ForCurrentProcess()->HasSwitch(
switches::kSyncThrowUnrecoverableError)) {
sync_manager_->ThrowUnrecoverableError();
}
}
void SyncBackendHost::Core::DoUpdateCredentials(
const SyncCredentials& credentials) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->UpdateCredentials(credentials);
}
void SyncBackendHost::Core::DoUpdateEnabledTypes(
const syncable::ModelTypeSet& enabled_types) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->UpdateEnabledTypes(enabled_types);
}
void SyncBackendHost::Core::DoStartSyncing(
const csync::ModelSafeRoutingInfo& routing_info) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->StartSyncingNormally(routing_info);
}
void SyncBackendHost::Core::DoRequestCleanupDisabledTypes(
const csync::ModelSafeRoutingInfo& routing_info) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->RequestCleanupDisabledTypes(routing_info);
}
void SyncBackendHost::Core::DoSetEncryptionPassphrase(
const std::string& passphrase,
bool is_explicit) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->SetEncryptionPassphrase(passphrase, is_explicit);
}
void SyncBackendHost::Core::DoSetDecryptionPassphrase(
const std::string& passphrase) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->SetDecryptionPassphrase(passphrase);
}
void SyncBackendHost::Core::DoEnableEncryptEverything() {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->EnableEncryptEverything();
}
void SyncBackendHost::Core::DoRefreshNigori(
const base::Closure& done_callback) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
chrome::VersionInfo version_info;
sync_manager_->RefreshNigori(version_info.CreateVersionString(),
done_callback);
}
void SyncBackendHost::Core::DoStopSyncManagerForShutdown(
const base::Closure& closure) {
DCHECK(sync_manager_.get());
sync_manager_->StopSyncingForShutdown(closure);
}
void SyncBackendHost::Core::DoShutdown(bool sync_disabled) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
if (!sync_manager_.get())
return;
save_changes_timer_.reset();
sync_manager_->ShutdownOnSyncThread();
sync_manager_->RemoveObserver(this);
sync_manager_.reset();
registrar_ = NULL;
if (sync_disabled)
DeleteSyncDataFolder();
sync_loop_ = NULL;
host_.Reset();
}
void SyncBackendHost::Core::DoRequestConfig(
const csync::ModelSafeRoutingInfo& routing_info,
syncable::ModelTypeSet types_to_config,
csync::ConfigureReason reason) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->RequestConfig(routing_info, types_to_config, reason);
}
void SyncBackendHost::Core::DoStartConfiguration(
const base::Closure& callback) {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->StartConfigurationMode(callback);
}
void SyncBackendHost::Core::DeleteSyncDataFolder() {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
if (file_util::DirectoryExists(sync_data_folder_path_)) {
if (!file_util::Delete(sync_data_folder_path_, true))
SLOG(DFATAL) << "Could not delete the Sync Data folder.";
}
}
void SyncBackendHost::Core::FinishConfigureDataTypes() {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
host_.Call(
FROM_HERE,
&SyncBackendHost::FinishConfigureDataTypesOnFrontendLoop);
}
void SyncBackendHost::Core::StartSavingChanges() {
// We may already be shut down.
if (!sync_loop_)
return;
DCHECK_EQ(MessageLoop::current(), sync_loop_);
DCHECK(!save_changes_timer_.get());
save_changes_timer_.reset(new base::RepeatingTimer<Core>());
save_changes_timer_->Start(FROM_HERE,
base::TimeDelta::FromSeconds(kSaveChangesIntervalSeconds),
this, &Core::SaveChanges);
}
void SyncBackendHost::Core::SaveChanges() {
DCHECK_EQ(MessageLoop::current(), sync_loop_);
sync_manager_->SaveChanges();
}
void SyncBackendHost::AddExperimentalTypes() {
CHECK(initialized());
csync::Experiments experiments;
if (core_->sync_manager()->ReceivedExperiment(&experiments))
frontend_->OnExperimentsChanged(experiments);
}
void SyncBackendHost::OnNigoriDownloadRetry() {
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
if (!frontend_)
return;
frontend_->OnSyncConfigureRetry();
}
void SyncBackendHost::HandleInitializationCompletedOnFrontendLoop(
const csync::WeakHandle<csync::JsBackend>& js_backend, bool success) {
DCHECK_NE(NOT_ATTEMPTED, initialization_state_);
if (!frontend_)
return;
// We've at least created the sync manager at this point, but if that is all
// we've done we're just beginning the initialization process.
if (initialization_state_ == CREATING_SYNC_MANAGER)
initialization_state_ = NOT_INITIALIZED;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
if (!success) {
initialization_state_ = NOT_INITIALIZED;
frontend_->OnBackendInitialized(
csync::WeakHandle<csync::JsBackend>(), false);
return;
}
// If setup has completed, start off in DOWNLOADING_NIGORI so that
// we start off by refreshing nigori.
CHECK(sync_prefs_.get());
if (sync_prefs_->HasSyncSetupCompleted() &&
initialization_state_ < DOWNLOADING_NIGORI) {
initialization_state_ = DOWNLOADING_NIGORI;
}
// Run initialization state machine.
switch (initialization_state_) {
case NOT_INITIALIZED:
initialization_state_ = DOWNLOADING_NIGORI;
ConfigureDataTypes(
csync::CONFIGURE_REASON_NEW_CLIENT,
syncable::ModelTypeSet(),
syncable::ModelTypeSet(),
WITH_NIGORI,
// Calls back into this function.
base::Bind(
&SyncBackendHost::
HandleNigoriConfigurationCompletedOnFrontendLoop,
weak_ptr_factory_.GetWeakPtr(), js_backend),
base::Bind(&SyncBackendHost::OnNigoriDownloadRetry,
weak_ptr_factory_.GetWeakPtr()));
break;
case DOWNLOADING_NIGORI:
initialization_state_ = REFRESHING_NIGORI;
// Triggers OnEncryptedTypesChanged() and OnEncryptionComplete()
// if necessary.
RefreshNigori(
base::Bind(
&SyncBackendHost::
HandleInitializationCompletedOnFrontendLoop,
weak_ptr_factory_.GetWeakPtr(), js_backend, true));
break;
case REFRESHING_NIGORI:
initialization_state_ = INITIALIZED;
// Now that we've downloaded the nigori node, we can see if there are any
// experimental types to enable. This should be done before we inform
// the frontend to ensure they're visible in the customize screen.
AddExperimentalTypes();
frontend_->OnBackendInitialized(js_backend, true);
break;
default:
NOTREACHED();
}
}
void SyncBackendHost::PersistEncryptionBootstrapToken(
const std::string& token) {
CHECK(sync_prefs_.get());
sync_prefs_->SetEncryptionBootstrapToken(token);
}
void SyncBackendHost::HandleActionableErrorEventOnFrontendLoop(
const csync::SyncProtocolError& sync_error) {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
frontend_->OnActionableError(sync_error);
}
bool SyncBackendHost::CheckPassphraseAgainstCachedPendingKeys(
const std::string& passphrase) const {
DCHECK(cached_pending_keys_.has_blob());
DCHECK(!passphrase.empty());
csync::Nigori nigori;
nigori.InitByDerivation("localhost", "dummy", passphrase);
std::string plaintext;
bool result = nigori.Decrypt(cached_pending_keys_.blob(), &plaintext);
return result;
}
void SyncBackendHost::NotifyPassphraseRequired(
csync::PassphraseRequiredReason reason,
sync_pb::EncryptedData pending_keys) {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// Update our cache of the cryptographer's pending keys.
cached_pending_keys_ = pending_keys;
frontend_->OnPassphraseRequired(reason, pending_keys);
}
void SyncBackendHost::NotifyPassphraseAccepted() {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
// Clear our cache of the cryptographer's pending keys.
cached_pending_keys_.clear_blob();
frontend_->OnPassphraseAccepted();
}
void SyncBackendHost::NotifyUpdatedToken(const std::string& token) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
TokenAvailableDetails details(GaiaConstants::kSyncService, token);
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_TOKEN_UPDATED,
content::Source<Profile>(profile_),
content::Details<const TokenAvailableDetails>(&details));
}
void SyncBackendHost::NotifyEncryptedTypesChanged(
syncable::ModelTypeSet encrypted_types,
bool encrypt_everything) {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
frontend_->OnEncryptedTypesChanged(
encrypted_types, encrypt_everything);
}
void SyncBackendHost::NotifyEncryptionComplete() {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
frontend_->OnEncryptionComplete();
}
void SyncBackendHost::HandleStopSyncingPermanentlyOnFrontendLoop() {
if (!frontend_)
return;
frontend_->OnStopSyncingPermanently();
}
void SyncBackendHost::HandleConnectionStatusChangeOnFrontendLoop(
csync::ConnectionStatus status) {
if (!frontend_)
return;
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
frontend_->OnConnectionStatusChange(status);
}
void SyncBackendHost::HandleNigoriConfigurationCompletedOnFrontendLoop(
const csync::WeakHandle<csync::JsBackend>& js_backend,
const syncable::ModelTypeSet failed_configuration_types) {
HandleInitializationCompletedOnFrontendLoop(
js_backend, failed_configuration_types.Empty());
}
namespace {
// Needed because MessageLoop::PostTask is overloaded.
void PostClosure(MessageLoop* message_loop,
const tracked_objects::Location& from_here,
const base::Closure& callback) {
message_loop->PostTask(from_here, callback);
}
} // namespace
void SyncBackendHost::RefreshNigori(const base::Closure& done_callback) {
DCHECK_EQ(MessageLoop::current(), frontend_loop_);
base::Closure sync_thread_done_callback =
base::Bind(&PostClosure,
MessageLoop::current(), FROM_HERE, done_callback);
sync_thread_.message_loop()->PostTask(
FROM_HERE,
base::Bind(&SyncBackendHost::Core::DoRefreshNigori,
core_.get(), sync_thread_done_callback));
}
#undef SDVLOG
#undef SLOG
} // namespace browser_sync
|