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
|
// 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 "chrome/browser/sync/glue/session_model_associator.h"
#include <algorithm>
#include <set>
#include <utility>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/threading/sequenced_worker_pool.h"
#include "base/utf_string_conversions.h"
#include "chrome/browser/favicon/favicon_service_factory.h"
#include "chrome/browser/history/history_service.h"
#include "chrome/browser/prefs/pref_service_syncable.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/sessions/session_id.h"
#include "chrome/browser/sync/glue/device_info.h"
#include "chrome/browser/sync/glue/synced_device_tracker.h"
#include "chrome/browser/sync/glue/synced_session.h"
#include "chrome/browser/sync/glue/synced_tab_delegate.h"
#include "chrome/browser/sync/glue/synced_window_delegate.h"
#include "chrome/browser/sync/profile_sync_service.h"
#include "chrome/common/chrome_notification_types.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/pref_names.h"
#include "chrome/common/url_constants.h"
#include "components/user_prefs/pref_registry_syncable.h"
#include "content/public/browser/navigation_entry.h"
#include "content/public/browser/notification_details.h"
#include "content/public/browser/notification_service.h"
#include "sync/api/sync_error.h"
#include "sync/api/time.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/base/model_type_invalidation_map.h"
#include "sync/internal_api/public/read_node.h"
#include "sync/internal_api/public/read_transaction.h"
#include "sync/internal_api/public/write_node.h"
#include "sync/internal_api/public/write_transaction.h"
#include "sync/protocol/session_specifics.pb.h"
#include "sync/syncable/directory.h"
#include "sync/syncable/syncable_read_transaction.h"
#include "sync/syncable/syncable_write_transaction.h"
#if defined(OS_LINUX)
#include "base/linux_util.h"
#elif defined(OS_WIN)
#include <windows.h>
#endif
using content::BrowserThread;
using content::NavigationEntry;
using prefs::kSyncSessionsGUID;
using syncer::SESSIONS;
namespace {
// Given a transaction, returns the GUID-based string that should be used for
// |current_machine_tag_|.
std::string GetMachineTagFromTransaction(
syncer::WriteTransaction* trans) {
syncer::syncable::Directory* dir = trans->GetWrappedWriteTrans()->directory();
std::string machine_tag = "session_sync";
machine_tag.append(dir->cache_guid());
return machine_tag;
}
} // namespace
namespace browser_sync {
namespace {
static const char kNoSessionsFolderError[] =
"Server did not create the top-level sessions node. We "
"might be running against an out-of-date server.";
// The maximum number of navigations in each direction we care to sync.
static const int kMaxSyncNavigationCount = 6;
// Default number of days without activity after which a session is considered
// stale and becomes a candidate for garbage collection.
static const size_t kDefaultStaleSessionThresholdDays = 14; // 2 weeks.
} // namespace
SessionModelAssociator::SessionModelAssociator(
ProfileSyncService* sync_service,
DataTypeErrorHandler* error_handler)
: tab_pool_(sync_service),
local_session_syncid_(syncer::kInvalidId),
sync_service_(sync_service),
stale_session_threshold_days_(kDefaultStaleSessionThresholdDays),
setup_for_test_(false),
waiting_for_change_(false),
ALLOW_THIS_IN_INITIALIZER_LIST(test_weak_factory_(this)),
profile_(sync_service->profile()),
error_handler_(error_handler),
favicon_cache_(profile_) {
DCHECK(CalledOnValidThread());
DCHECK(sync_service_);
DCHECK(profile_);
const CommandLine& command_line = *CommandLine::ForCurrentProcess();
if (command_line.HasSwitch(switches::kSyncTabFavicons))
favicon_cache_.SetLegacyDelegate(this);
}
SessionModelAssociator::SessionModelAssociator(ProfileSyncService* sync_service,
bool setup_for_test)
: tab_pool_(sync_service),
local_session_syncid_(syncer::kInvalidId),
sync_service_(sync_service),
stale_session_threshold_days_(kDefaultStaleSessionThresholdDays),
setup_for_test_(setup_for_test),
waiting_for_change_(false),
ALLOW_THIS_IN_INITIALIZER_LIST(test_weak_factory_(this)),
profile_(sync_service->profile()),
error_handler_(NULL),
favicon_cache_(profile_) {
DCHECK(CalledOnValidThread());
DCHECK(sync_service_);
DCHECK(profile_);
DCHECK(setup_for_test);
}
SessionModelAssociator::~SessionModelAssociator() {
DCHECK(CalledOnValidThread());
}
bool SessionModelAssociator::InitSyncNodeFromChromeId(
const std::string& id,
syncer::BaseNode* sync_node) {
NOTREACHED();
return false;
}
bool SessionModelAssociator::SyncModelHasUserCreatedNodes(bool* has_nodes) {
DCHECK(CalledOnValidThread());
CHECK(has_nodes);
*has_nodes = false;
syncer::ReadTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::ReadNode root(&trans);
if (root.InitByTagLookup(syncer::ModelTypeToRootTag(syncer::SESSIONS)) !=
syncer::BaseNode::INIT_OK) {
LOG(ERROR) << kNoSessionsFolderError;
return false;
}
// The sync model has user created nodes iff the sessions folder has
// any children.
*has_nodes = root.HasChildren();
return true;
}
int64 SessionModelAssociator::GetSyncIdFromChromeId(const size_t& id) {
DCHECK(CalledOnValidThread());
return GetSyncIdFromSessionTag(
TabNodePool::TabIdToTag(GetCurrentMachineTag(), id));
}
int64 SessionModelAssociator::GetSyncIdFromSessionTag(const std::string& tag) {
DCHECK(CalledOnValidThread());
syncer::ReadTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::ReadNode node(&trans);
if (node.InitByClientTagLookup(SESSIONS, tag) != syncer::BaseNode::INIT_OK)
return syncer::kInvalidId;
return node.GetId();
}
const size_t*
SessionModelAssociator::GetChromeNodeFromSyncId(int64 sync_id) {
NOTREACHED();
return NULL;
}
bool SessionModelAssociator::InitSyncNodeFromChromeId(
const size_t& id,
syncer::BaseNode* sync_node) {
NOTREACHED();
return false;
}
bool SessionModelAssociator::AssociateWindows(bool reload_tabs,
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
std::string local_tag = GetCurrentMachineTag();
sync_pb::SessionSpecifics specifics;
specifics.set_session_tag(local_tag);
sync_pb::SessionHeader* header_s = specifics.mutable_header();
SyncedSession* current_session =
synced_session_tracker_.GetSession(local_tag);
current_session->modified_time = base::Time::Now();
header_s->set_client_name(current_session_name_);
header_s->set_device_type(DeviceInfo::GetLocalDeviceType());
synced_session_tracker_.ResetSessionTracking(local_tag);
std::set<SyncedWindowDelegate*> windows =
SyncedWindowDelegate::GetSyncedWindowDelegates();
for (std::set<SyncedWindowDelegate*>::const_iterator i =
windows.begin(); i != windows.end(); ++i) {
// Make sure the window has tabs and a viewable window. The viewable window
// check is necessary because, for example, when a browser is closed the
// destructor is not necessarily run immediately. This means its possible
// for us to get a handle to a browser that is about to be removed. If
// the tab count is 0 or the window is NULL, the browser is about to be
// deleted, so we ignore it.
if (ShouldSyncWindow(*i) && (*i)->GetTabCount() && (*i)->HasWindow()) {
sync_pb::SessionWindow window_s;
SessionID::id_type window_id = (*i)->GetSessionId();
DVLOG(1) << "Associating window " << window_id << " with "
<< (*i)->GetTabCount() << " tabs.";
window_s.set_window_id(window_id);
// Note: We don't bother to set selected tab index anymore. We still
// consume it when receiving foreign sessions, as reading it is free, but
// it triggers too many sync cycles with too little value to make setting
// it worthwhile.
if ((*i)->IsTypeTabbed()) {
window_s.set_browser_type(
sync_pb::SessionWindow_BrowserType_TYPE_TABBED);
} else {
window_s.set_browser_type(
sync_pb::SessionWindow_BrowserType_TYPE_POPUP);
}
// Store the order of tabs.
bool found_tabs = false;
for (int j = 0; j < (*i)->GetTabCount(); ++j) {
SessionID::id_type tab_id = (*i)->GetTabIdAt(j);
if (reload_tabs) {
SyncedTabDelegate* tab = (*i)->GetTabAt(j);
// It's possible for GetTabAt to return a null tab if it's not in
// memory. We can assume this means the tab already existed but hasn't
// changed, so no need to reassociate.
if (tab && !AssociateTab(*tab, error)) {
// Association failed. Either we need to re-associate, or this is an
// unrecoverable error.
return false;
}
}
// If the tab is valid, it would have been added to the tracker either
// by the above AssociateTab call (at association time), or by the
// change processor calling AssociateTab for all modified tabs.
// Therefore, we can key whether this window has valid tabs based on
// the tab's presence in the tracker.
const SessionTab* tab = NULL;
if (synced_session_tracker_.LookupSessionTab(local_tag, tab_id, &tab)) {
found_tabs = true;
window_s.add_tab(tab_id);
}
}
// Only add a window if it contains valid tabs.
if (found_tabs) {
sync_pb::SessionWindow* header_window = header_s->add_window();
*header_window = window_s;
// Update this window's representation in the synced session tracker.
synced_session_tracker_.PutWindowInSession(local_tag, window_id);
PopulateSessionWindowFromSpecifics(
local_tag,
window_s,
base::Time::Now(),
current_session->windows[window_id],
&synced_session_tracker_);
}
}
}
// Free memory for closed windows and tabs.
synced_session_tracker_.CleanupSession(local_tag);
syncer::WriteTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::WriteNode header_node(&trans);
if (header_node.InitByIdLookup(local_session_syncid_) !=
syncer::BaseNode::INIT_OK) {
if (error) {
*error = error_handler_->CreateAndUploadError(
FROM_HERE,
"Failed to load local session header node.",
model_type());
}
return false;
}
header_node.SetSessionSpecifics(specifics);
if (waiting_for_change_) QuitLoopForSubtleTesting();
return true;
}
// Static.
bool SessionModelAssociator::ShouldSyncWindow(
const SyncedWindowDelegate* window) {
if (window->IsApp())
return false;
return window->IsTypeTabbed() || window->IsTypePopup();
}
bool SessionModelAssociator::AssociateTabs(
const std::vector<SyncedTabDelegate*>& tabs,
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
for (std::vector<SyncedTabDelegate*>::const_iterator i = tabs.begin();
i != tabs.end();
++i) {
if (!AssociateTab(**i, error))
return false;
}
if (waiting_for_change_) QuitLoopForSubtleTesting();
return true;
}
bool SessionModelAssociator::AssociateTab(const SyncedTabDelegate& tab,
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
int64 sync_id;
SessionID::id_type tab_id = tab.GetSessionId();
if (tab.IsBeingDestroyed()) {
// This tab is closing.
TabLinksMap::iterator tab_iter = tab_map_.find(tab_id);
if (tab_iter == tab_map_.end()) {
// We aren't tracking this tab (for example, sync setting page).
return true;
}
tab_pool_.FreeTabNode(tab_iter->second->sync_id());
tab_map_.erase(tab_iter);
return true;
}
if (!ShouldSyncTab(tab))
return true;
TabLinksMap::iterator tab_map_iter = tab_map_.find(tab_id);
TabLink* tab_link = NULL;
if (tab_map_iter == tab_map_.end()) {
// This is a new tab, get a sync node for it.
sync_id = tab_pool_.GetFreeTabNode();
if (sync_id == syncer::kInvalidId) {
if (error) {
*error = error_handler_->CreateAndUploadError(
FROM_HERE,
"Received invalid tab node from tab pool.",
model_type());
}
return false;
}
tab_link = new TabLink(sync_id, &tab);
tab_map_[tab_id] = make_linked_ptr<TabLink>(tab_link);
} else {
// This tab is already associated with a sync node, reuse it.
// Note: on some platforms the tab object may have changed, so we ensure
// the tab link is up to date.
tab_link = tab_map_iter->second.get();
tab_map_iter->second->set_tab(&tab);
}
DCHECK(tab_link);
DCHECK_NE(tab_link->sync_id(), syncer::kInvalidId);
DVLOG(1) << "Reloading tab " << tab_id << " from window "
<< tab.GetWindowId();
return WriteTabContentsToSyncModel(tab_link, error);
}
// static
GURL SessionModelAssociator::GetCurrentVirtualURL(
const SyncedTabDelegate& tab_delegate) {
GURL new_url;
const int current_index = tab_delegate.GetCurrentEntryIndex();
const int pending_index = tab_delegate.GetPendingEntryIndex();
const NavigationEntry* current_entry =
(current_index == pending_index) ?
tab_delegate.GetPendingEntry() :
tab_delegate.GetEntryAtIndex(current_index);
return current_entry->GetVirtualURL();
}
bool SessionModelAssociator::WriteTabContentsToSyncModel(
TabLink* tab_link,
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
const SyncedTabDelegate& tab_delegate = *(tab_link->tab());
int64 sync_id = tab_link->sync_id();
GURL old_tab_url = tab_link->url();
// Load the last stored version of this tab so we can compare changes. If this
// is a new tab, session_tab will be a blank/newly created SessionTab object.
SessionTab* session_tab =
synced_session_tracker_.GetTab(GetCurrentMachineTag(),
tab_delegate.GetSessionId());
SetSessionTabFromDelegate(tab_delegate, base::Time::Now(), session_tab);
const GURL new_url = GetCurrentVirtualURL(tab_delegate);
DVLOG(1) << "Local tab " << tab_delegate.GetSessionId()
<< " now has URL " << new_url.spec();
// Trigger the favicon load if needed. We do this before opening the write
// transaction to avoid jank.
tab_link->set_url(new_url);
if (new_url != old_tab_url)
favicon_cache_.OnFaviconVisited(new_url, GURL());
// Update our last modified time.
synced_session_tracker_.GetSession(GetCurrentMachineTag())->modified_time =
base::Time::Now();
syncer::WriteTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::WriteNode tab_node(&trans);
if (tab_node.InitByIdLookup(sync_id) != syncer::BaseNode::INIT_OK) {
if (error) {
*error = error_handler_->CreateAndUploadError(
FROM_HERE,
"Failed to look up local tab node",
model_type());
}
return false;
}
sync_pb::SessionTab tab_s = session_tab->ToSyncData();
sync_pb::SessionSpecifics specifics = tab_node.GetSessionSpecifics();
if (new_url == old_tab_url) {
// Load the old specifics and copy over the favicon data if needed.
// TODO(zea): remove this once favicon sync is enabled as a separate type.
tab_s.set_favicon(specifics.tab().favicon());
tab_s.set_favicon_source(specifics.tab().favicon_source());
tab_s.set_favicon_type(specifics.tab().favicon_type());
}
// Retain the base SessionSpecifics data (tag, tab_node_id, etc.), and just
// write the new SessionTabSpecifics.
specifics.mutable_tab()->CopyFrom(tab_s);
// Write into the actual sync model.
tab_node.SetSessionSpecifics(specifics);
return true;
}
// static
void SessionModelAssociator::SetSessionTabFromDelegate(
const SyncedTabDelegate& tab_delegate,
base::Time mtime,
SessionTab* session_tab) {
DCHECK(session_tab);
session_tab->window_id.set_id(tab_delegate.GetWindowId());
session_tab->tab_id.set_id(tab_delegate.GetSessionId());
session_tab->tab_visual_index = 0;
session_tab->current_navigation_index = tab_delegate.GetCurrentEntryIndex();
session_tab->pinned = tab_delegate.IsPinned();
session_tab->extension_app_id = tab_delegate.GetExtensionAppId();
session_tab->user_agent_override.clear();
session_tab->timestamp = mtime;
const int current_index = tab_delegate.GetCurrentEntryIndex();
const int pending_index = tab_delegate.GetPendingEntryIndex();
const int min_index = std::max(0,
current_index - kMaxSyncNavigationCount);
const int max_index = std::min(current_index + kMaxSyncNavigationCount,
tab_delegate.GetEntryCount());
session_tab->navigations.clear();
for (int i = min_index; i < max_index; ++i) {
const NavigationEntry* entry = (i == pending_index) ?
tab_delegate.GetPendingEntry() : tab_delegate.GetEntryAtIndex(i);
DCHECK(entry);
if (entry->GetVirtualURL().is_valid()) {
session_tab->navigations.push_back(
TabNavigation::FromNavigationEntry(i, *entry));
}
}
session_tab->session_storage_persistent_id.clear();
}
void SessionModelAssociator::FaviconsUpdated(
const std::set<GURL>& urls) {
// TODO(zea): consider a separate container for tabs with outstanding favicon
// loads so we don't have to iterate through all tabs comparing urls.
for (std::set<GURL>::const_iterator i = urls.begin(); i != urls.end(); ++i) {
for (TabLinksMap::iterator tab_iter = tab_map_.begin();
tab_iter != tab_map_.end();
++tab_iter) {
if (tab_iter->second->url() == *i)
favicon_cache_.OnPageFaviconUpdated(*i);
}
}
}
void SessionModelAssociator::Associate(const size_t* tab,
int64 sync_id) {
NOTIMPLEMENTED();
}
void SessionModelAssociator::Disassociate(int64 sync_id) {
DCHECK(CalledOnValidThread());
NOTIMPLEMENTED();
}
void SessionModelAssociator::OnFaviconUpdated(
const GURL& page_url,
const GURL& icon_url) {
TabLink* tab_link = NULL;
for (TabLinksMap::const_iterator iter = tab_map_.begin();
iter != tab_map_.end(); ++iter) {
if (iter->second->url() == page_url) {
tab_link = iter->second.get();
if (tab_link->sync_id() == syncer::kInvalidId)
continue;
scoped_refptr<base::RefCountedMemory> favicon_png;
if (!favicon_cache_.GetSyncedFaviconForPageURL(page_url, &favicon_png)) {
LOG(ERROR) << "Unable to look up favicon for page url after "
<< "notification";
}
// Load the sync tab node and update the favicon data.
syncer::WriteTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::WriteNode tab_node(&trans);
if (tab_node.InitByIdLookup(tab_link->sync_id()) !=
syncer::BaseNode::INIT_OK) {
LOG(WARNING) << "Failed to load sync tab node for url "
<< tab_link->url().spec();
return;
}
sync_pb::SessionSpecifics session_specifics =
tab_node.GetSessionSpecifics();
DCHECK(session_specifics.has_tab());
sync_pb::SessionTab* tab = session_specifics.mutable_tab();
if (favicon_png.get() && favicon_png->size() > 0) {
DVLOG(1) << "Storing session favicon for "
<< tab_link->url() << " with size "
<< favicon_png->size() << " bytes.";
tab->set_favicon(favicon_png->front(),
favicon_png->size());
tab->set_favicon_type(sync_pb::SessionTab::TYPE_WEB_FAVICON);
tab->set_favicon_source(icon_url.spec());
} else {
LOG(WARNING) << "Null favicon stored for url "
<< tab_link->url().spec();
}
tab_node.SetSessionSpecifics(session_specifics);
}
}
}
syncer::SyncError SessionModelAssociator::AssociateModels(
syncer::SyncMergeResult* local_merge_result,
syncer::SyncMergeResult* syncer_merge_result) {
DCHECK(CalledOnValidThread());
syncer::SyncError error;
// Ensure that we disassociated properly, otherwise memory might leak.
DCHECK(synced_session_tracker_.Empty());
DCHECK_EQ(0U, tab_pool_.capacity());
local_session_syncid_ = syncer::kInvalidId;
scoped_ptr<DeviceInfo> local_device_info(sync_service_->GetLocalDeviceInfo());
#if defined(OS_ANDROID)
std::string transaction_tag;
#endif
// Read any available foreign sessions and load any session data we may have.
// If we don't have any local session data in the db, create a header node.
{
syncer::WriteTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::ReadNode root(&trans);
if (root.InitByTagLookup(syncer::ModelTypeToRootTag(model_type())) !=
syncer::BaseNode::INIT_OK) {
return error_handler_->CreateAndUploadError(
FROM_HERE,
kNoSessionsFolderError,
model_type());
}
// Make sure we have a machine tag.
if (current_machine_tag_.empty())
InitializeCurrentMachineTag(&trans);
if (local_device_info.get()) {
current_session_name_ = local_device_info->client_name();
} else {
return error_handler_->CreateAndUploadError(
FROM_HERE,
"Failed to get device info.",
model_type());
}
synced_session_tracker_.SetLocalSessionTag(current_machine_tag_);
if (!UpdateAssociationsFromSyncModel(root, &trans, &error)) {
DCHECK(error.IsSet());
return error;
}
if (local_session_syncid_ == syncer::kInvalidId) {
// The sync db didn't have a header node for us, we need to create one.
syncer::WriteNode write_node(&trans);
syncer::WriteNode::InitUniqueByCreationResult result =
write_node.InitUniqueByCreation(SESSIONS, root, current_machine_tag_);
if (result != syncer::WriteNode::INIT_SUCCESS) {
// If we can't look it up, and we can't create it, chances are there's
// a pre-existing node that has encryption issues. But, since we can't
// load the item, we can't remove it, and error out at this point.
return error_handler_->CreateAndUploadError(
FROM_HERE,
"Failed to create sessions header sync node.",
model_type());
}
// Write the initial values to the specifics so that in case of a crash or
// error we don't persist a half-written node.
write_node.SetTitle(UTF8ToWide(current_machine_tag_));
sync_pb::SessionSpecifics base_specifics;
base_specifics.set_session_tag(current_machine_tag_);
sync_pb::SessionHeader* header_s = base_specifics.mutable_header();
header_s->set_client_name(current_session_name_);
header_s->set_device_type(DeviceInfo::GetLocalDeviceType());
write_node.SetSessionSpecifics(base_specifics);
local_session_syncid_ = write_node.GetId();
}
#if defined(OS_ANDROID)
transaction_tag = GetMachineTagFromTransaction(&trans);
#endif
}
#if defined(OS_ANDROID)
// We need to delete foreign sessions after giving up our
// syncer::WriteTransaction, since DeleteForeignSession(std::string&) uses
// its own syncer::WriteTransaction.
if (current_machine_tag_.compare(transaction_tag) != 0)
DeleteForeignSession(transaction_tag);
#endif
// Check if anything has changed on the client side.
if (!UpdateSyncModelDataFromClient(&error)) {
DCHECK(error.IsSet());
return error;
}
DVLOG(1) << "Session models associated.";
DCHECK(!error.IsSet());
return error;
}
syncer::SyncError SessionModelAssociator::DisassociateModels() {
DCHECK(CalledOnValidThread());
DVLOG(1) << "Disassociating local session " << GetCurrentMachineTag();
favicon_cache_.RemoveLegacyDelegate();
synced_session_tracker_.Clear();
tab_map_.clear();
tab_pool_.clear();
local_session_syncid_ = syncer::kInvalidId;
current_machine_tag_ = "";
current_session_name_ = "";
// There is no local model stored with which to disassociate, just notify
// foreign session handlers.
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_FOREIGN_SESSION_DISABLED,
content::Source<Profile>(sync_service_->profile()),
content::NotificationService::NoDetails());
return syncer::SyncError();
}
void SessionModelAssociator::InitializeCurrentMachineTag(
syncer::WriteTransaction* trans) {
DCHECK(CalledOnValidThread());
DCHECK(current_machine_tag_.empty());
std::string persisted_guid;
browser_sync::SyncPrefs prefs(profile_->GetPrefs());
persisted_guid = prefs.GetSyncSessionsGUID();
if (!persisted_guid.empty()) {
current_machine_tag_ = persisted_guid;
DVLOG(1) << "Restoring persisted session sync guid: "
<< persisted_guid;
} else {
current_machine_tag_ = GetMachineTagFromTransaction(trans);
DVLOG(1) << "Creating session sync guid: " << current_machine_tag_;
prefs.SetSyncSessionsGUID(current_machine_tag_);
}
tab_pool_.set_machine_tag(current_machine_tag_);
}
bool SessionModelAssociator::GetSyncedFaviconForPageURL(
const std::string& page_url,
scoped_refptr<base::RefCountedMemory>* favicon_png) const {
return favicon_cache_.GetSyncedFaviconForPageURL(GURL(page_url), favicon_png);
}
bool SessionModelAssociator::UpdateAssociationsFromSyncModel(
const syncer::ReadNode& root,
syncer::WriteTransaction* trans,
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
DCHECK(tab_pool_.empty());
DCHECK_EQ(local_session_syncid_, syncer::kInvalidId);
// Iterate through the nodes and associate any foreign sessions.
int64 id = root.GetFirstChildId();
while (id != syncer::kInvalidId) {
syncer::WriteNode sync_node(trans);
if (sync_node.InitByIdLookup(id) != syncer::BaseNode::INIT_OK) {
if (error) {
*error = error_handler_->CreateAndUploadError(
FROM_HERE,
"Failed to load sync node",
model_type());
}
return false;
}
int64 next_id = sync_node.GetSuccessorId();
const sync_pb::SessionSpecifics& specifics =
sync_node.GetSessionSpecifics();
const base::Time& modification_time = sync_node.GetModificationTime();
if (specifics.session_tag().empty()) {
// This is a corrupted node. Just delete it.
LOG(WARNING) << "Found node with no session tag, deleting.";
sync_node.Tombstone();
} else if (specifics.session_tag() != GetCurrentMachineTag()) {
AssociateForeignSpecifics(specifics, modification_time);
} else {
// This is previously stored local session information.
if (specifics.has_header() &&
local_session_syncid_ == syncer::kInvalidId) {
// This is our previous header node, reuse it.
local_session_syncid_ = id;
if (specifics.header().has_client_name()) {
current_session_name_ = specifics.header().client_name();
}
} else {
if (specifics.has_header()) {
LOG(WARNING) << "Found more than one session header node with local "
<< " tag.";
} else if (!specifics.has_tab()) {
LOG(WARNING) << "Found local node with no header or tag field.";
}
// TODO(zea): fix this once we add support for reassociating
// pre-existing tabs with pre-existing tab nodes. We'll need to load
// the tab_node_id and ensure the tab_pool_ keeps track of them.
sync_node.Tombstone();
}
}
id = next_id;
}
// After updating from sync model all tabid's should be free.
DCHECK(tab_pool_.full());
return true;
}
void SessionModelAssociator::AssociateForeignSpecifics(
const sync_pb::SessionSpecifics& specifics,
const base::Time& modification_time) {
DCHECK(CalledOnValidThread());
std::string foreign_session_tag = specifics.session_tag();
if (foreign_session_tag == GetCurrentMachineTag() && !setup_for_test_)
return;
SyncedSession* foreign_session =
synced_session_tracker_.GetSession(foreign_session_tag);
if (specifics.has_header()) {
// Read in the header data for this foreign session.
// Header data contains window information and ordered tab id's for each
// window.
// Load (or create) the SyncedSession object for this client.
const sync_pb::SessionHeader& header = specifics.header();
PopulateSessionHeaderFromSpecifics(header,
modification_time,
foreign_session);
// Reset the tab/window tracking for this session (must do this before
// we start calling PutWindowInSession and PutTabInWindow so that all
// unused tabs/windows get cleared by the CleanupSession(...) call).
synced_session_tracker_.ResetSessionTracking(foreign_session_tag);
// Process all the windows and their tab information.
int num_windows = header.window_size();
DVLOG(1) << "Associating " << foreign_session_tag << " with "
<< num_windows << " windows.";
for (int i = 0; i < num_windows; ++i) {
const sync_pb::SessionWindow& window_s = header.window(i);
SessionID::id_type window_id = window_s.window_id();
synced_session_tracker_.PutWindowInSession(foreign_session_tag,
window_id);
PopulateSessionWindowFromSpecifics(foreign_session_tag,
window_s,
modification_time,
foreign_session->windows[window_id],
&synced_session_tracker_);
}
// Delete any closed windows and unused tabs as necessary.
synced_session_tracker_.CleanupSession(foreign_session_tag);
} else if (specifics.has_tab()) {
const sync_pb::SessionTab& tab_s = specifics.tab();
SessionID::id_type tab_id = tab_s.tab_id();
SessionTab* tab =
synced_session_tracker_.GetTab(foreign_session_tag, tab_id);
// Update SessionTab based on protobuf.
tab->SetFromSyncData(tab_s, modification_time);
// If a favicon or favicon urls are present, load them into the in-memory
// favicon cache.
LoadForeignTabFavicon(tab_s);
// Update the last modified time.
if (foreign_session->modified_time < modification_time)
foreign_session->modified_time = modification_time;
} else {
LOG(WARNING) << "Ignoring foreign session node with missing header/tab "
<< "fields and tag " << foreign_session_tag << ".";
}
}
bool SessionModelAssociator::DisassociateForeignSession(
const std::string& foreign_session_tag) {
DCHECK(CalledOnValidThread());
if (foreign_session_tag == GetCurrentMachineTag()) {
DVLOG(1) << "Local session deleted! Doing nothing until a navigation is "
<< "triggered.";
return false;
}
DVLOG(1) << "Disassociating session " << foreign_session_tag;
return synced_session_tracker_.DeleteSession(foreign_session_tag);
}
// Static
void SessionModelAssociator::PopulateSessionHeaderFromSpecifics(
const sync_pb::SessionHeader& header_specifics,
base::Time mtime,
SyncedSession* session_header) {
if (header_specifics.has_client_name()) {
session_header->session_name = header_specifics.client_name();
}
if (header_specifics.has_device_type()) {
switch (header_specifics.device_type()) {
case sync_pb::SyncEnums_DeviceType_TYPE_WIN:
session_header->device_type = SyncedSession::TYPE_WIN;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_MAC:
session_header->device_type = SyncedSession::TYPE_MACOSX;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_LINUX:
session_header->device_type = SyncedSession::TYPE_LINUX;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_CROS:
session_header->device_type = SyncedSession::TYPE_CHROMEOS;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_PHONE:
session_header->device_type = SyncedSession::TYPE_PHONE;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_TABLET:
session_header->device_type = SyncedSession::TYPE_TABLET;
break;
case sync_pb::SyncEnums_DeviceType_TYPE_OTHER:
// Intentionally fall-through
default:
session_header->device_type = SyncedSession::TYPE_OTHER;
break;
}
}
session_header->modified_time = mtime;
}
// Static
void SessionModelAssociator::PopulateSessionWindowFromSpecifics(
const std::string& session_tag,
const sync_pb::SessionWindow& specifics,
base::Time mtime,
SessionWindow* session_window,
SyncedSessionTracker* tracker) {
if (specifics.has_window_id())
session_window->window_id.set_id(specifics.window_id());
if (specifics.has_selected_tab_index())
session_window->selected_tab_index = specifics.selected_tab_index();
if (specifics.has_browser_type()) {
if (specifics.browser_type() ==
sync_pb::SessionWindow_BrowserType_TYPE_TABBED) {
session_window->type = 1;
} else {
session_window->type = 2;
}
}
session_window->timestamp = mtime;
session_window->tabs.resize(specifics.tab_size(), NULL);
for (int i = 0; i < specifics.tab_size(); i++) {
SessionID::id_type tab_id = specifics.tab(i);
tracker->PutTabInWindow(session_tag,
session_window->window_id.id(),
tab_id,
i);
}
}
void SessionModelAssociator::LoadForeignTabFavicon(
const sync_pb::SessionTab& tab) {
// First go through and iterate over all the navigations, checking if any
// have valid favicon urls.
for (int i = 0; i < tab.navigation_size(); ++i) {
if (!tab.navigation(i).favicon_url().empty()) {
const std::string& page_url = tab.navigation(i).virtual_url();
const std::string& favicon_url = tab.navigation(i).favicon_url();
favicon_cache_.OnReceivedSyncFavicon(GURL(page_url),
GURL(favicon_url),
std::string(),
syncer::TimeToProtoTime(
base::Time::Now()));
}
}
// Then go through and check for any legacy favicon data.
if (!tab.has_favicon() || tab.favicon().empty())
return;
if (!tab.has_favicon_type() ||
tab.favicon_type() != sync_pb::SessionTab::TYPE_WEB_FAVICON) {
DVLOG(1) << "Ignoring non-web favicon.";
return;
}
if (tab.navigation_size() == 0)
return;
int selected_index = tab.current_navigation_index();
selected_index = std::max(
0,
std::min(selected_index,
static_cast<int>(tab.navigation_size() - 1)));
GURL navigation_url(tab.navigation(selected_index).virtual_url());
if (!navigation_url.is_valid())
return;
GURL favicon_source(tab.favicon_source());
if (!favicon_source.is_valid())
return;
const std::string& favicon = tab.favicon();
DVLOG(1) << "Storing synced favicon for url " << navigation_url.spec()
<< " with size " << favicon.size() << " bytes.";
favicon_cache_.OnReceivedSyncFavicon(navigation_url,
favicon_source,
favicon,
syncer::TimeToProtoTime(
base::Time::Now()));
}
bool SessionModelAssociator::UpdateSyncModelDataFromClient(
syncer::SyncError* error) {
DCHECK(CalledOnValidThread());
// Associate all open windows and their tabs.
return AssociateWindows(true, error);
}
void SessionModelAssociator::AttemptSessionsDataRefresh() const {
DVLOG(1) << "Triggering sync refresh for sessions datatype.";
const syncer::ModelTypeSet types(syncer::SESSIONS);
const syncer::ModelTypeInvalidationMap& invalidation_map =
ModelTypeSetToInvalidationMap(types, std::string());
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_SYNC_REFRESH_LOCAL,
content::Source<Profile>(profile_),
content::Details<const syncer::ModelTypeInvalidationMap>(
&invalidation_map));
}
bool SessionModelAssociator::GetLocalSession(
const SyncedSession* * local_session) {
DCHECK(CalledOnValidThread());
if (current_machine_tag_.empty())
return false;
*local_session = synced_session_tracker_.GetSession(GetCurrentMachineTag());
return true;
}
bool SessionModelAssociator::GetAllForeignSessions(
std::vector<const SyncedSession*>* sessions) {
DCHECK(CalledOnValidThread());
return synced_session_tracker_.LookupAllForeignSessions(sessions);
}
bool SessionModelAssociator::GetForeignSession(
const std::string& tag,
std::vector<const SessionWindow*>* windows) {
DCHECK(CalledOnValidThread());
return synced_session_tracker_.LookupSessionWindows(tag, windows);
}
bool SessionModelAssociator::GetForeignTab(
const std::string& tag,
const SessionID::id_type tab_id,
const SessionTab** tab) {
DCHECK(CalledOnValidThread());
const SessionTab* synced_tab = NULL;
bool success = synced_session_tracker_.LookupSessionTab(tag,
tab_id,
&synced_tab);
if (success)
*tab = synced_tab;
return success;
}
void SessionModelAssociator::DeleteStaleSessions() {
DCHECK(CalledOnValidThread());
std::vector<const SyncedSession*> sessions;
if (!GetAllForeignSessions(&sessions))
return; // No foreign sessions.
// Iterate through all the sessions and delete any with age older than
// |stale_session_threshold_days_|.
for (std::vector<const SyncedSession*>::const_iterator iter =
sessions.begin(); iter != sessions.end(); ++iter) {
const SyncedSession* session = *iter;
int session_age_in_days =
(base::Time::Now() - session->modified_time).InDays();
std::string session_tag = session->session_tag;
if (session_age_in_days > 0 && // If false, local clock is not trustworty.
static_cast<size_t>(session_age_in_days) >
stale_session_threshold_days_) {
DVLOG(1) << "Found stale session " << session_tag
<< " with age " << session_age_in_days << ", deleting.";
DeleteForeignSession(session_tag);
}
}
}
void SessionModelAssociator::SetStaleSessionThreshold(
size_t stale_session_threshold_days) {
DCHECK(CalledOnValidThread());
if (stale_session_threshold_days_ == 0) {
NOTREACHED() << "Attempted to set invalid stale session threshold.";
return;
}
stale_session_threshold_days_ = stale_session_threshold_days;
// TODO(zea): maybe make this preference-based? Might be nice to let users be
// able to modify this once and forget about it. At the moment, if we want a
// different threshold we will need to call this everytime we create a new
// model associator and before we AssociateModels (probably from DTC).
}
void SessionModelAssociator::DeleteForeignSession(const std::string& tag) {
DCHECK(CalledOnValidThread());
if (tag == GetCurrentMachineTag()) {
LOG(ERROR) << "Attempting to delete local session. This is not currently "
<< "supported.";
return;
}
if (!DisassociateForeignSession(tag)) {
// We don't have any data for this session, our work here is done!
return;
}
syncer::WriteTransaction trans(FROM_HERE, sync_service_->GetUserShare());
syncer::ReadNode root(&trans);
if (root.InitByTagLookup(syncer::ModelTypeToRootTag(syncer::SESSIONS)) !=
syncer::BaseNode::INIT_OK) {
LOG(ERROR) << kNoSessionsFolderError;
return;
}
int64 id = root.GetFirstChildId();
while (id != syncer::kInvalidId) {
syncer::WriteNode sync_node(&trans);
if (sync_node.InitByIdLookup(id) != syncer::BaseNode::INIT_OK) {
LOG(ERROR) << "Failed to fetch sync node for id " << id;
continue;
}
id = sync_node.GetSuccessorId();
const sync_pb::SessionSpecifics& specifics =
sync_node.GetSessionSpecifics();
if (specifics.session_tag() == tag)
sync_node.Tombstone();
}
}
bool SessionModelAssociator::IsValidTab(const SyncedTabDelegate& tab) const {
if ((!sync_service_ || tab.profile() != sync_service_->profile()) &&
!setup_for_test_) {
return false;
}
const SyncedWindowDelegate* window =
SyncedWindowDelegate::FindSyncedWindowDelegateWithId(
tab.GetWindowId());
if (!window && !setup_for_test_)
return false;
return true;
}
bool SessionModelAssociator::TabHasValidEntry(
const SyncedTabDelegate& tab) const {
int pending_index = tab.GetPendingEntryIndex();
int entry_count = tab.GetEntryCount();
bool found_valid_url = false;
if (entry_count == 0)
return false; // This deliberately ignores a new pending entry.
for (int i = 0; i < entry_count; ++i) {
const content::NavigationEntry* entry = (i == pending_index) ?
tab.GetPendingEntry() : tab.GetEntryAtIndex(i);
if (!entry)
return false;
if (entry->GetVirtualURL().is_valid() &&
!entry->GetVirtualURL().SchemeIs("chrome") &&
!entry->GetVirtualURL().SchemeIsFile()) {
found_valid_url = true;
}
}
return found_valid_url;
}
// If this functionality changes, SyncedSession::ShouldSyncSessionTab should be
// modified to match.
bool SessionModelAssociator::ShouldSyncTab(const SyncedTabDelegate& tab) const {
DCHECK(CalledOnValidThread());
if (!IsValidTab(tab))
return false;
return TabHasValidEntry(tab);
}
void SessionModelAssociator::QuitLoopForSubtleTesting() {
if (waiting_for_change_) {
DVLOG(1) << "Quitting MessageLoop for test.";
waiting_for_change_ = false;
test_weak_factory_.InvalidateWeakPtrs();
MessageLoop::current()->Quit();
}
}
FaviconCache* SessionModelAssociator::GetFaviconCache() {
return &favicon_cache_;
}
void SessionModelAssociator::BlockUntilLocalChangeForTest(
base::TimeDelta timeout) {
if (test_weak_factory_.HasWeakPtrs())
return;
waiting_for_change_ = true;
MessageLoop::current()->PostDelayedTask(
FROM_HERE,
base::Bind(&SessionModelAssociator::QuitLoopForSubtleTesting,
test_weak_factory_.GetWeakPtr()),
timeout);
}
bool SessionModelAssociator::CryptoReadyIfNecessary() {
// We only access the cryptographer while holding a transaction.
syncer::ReadTransaction trans(FROM_HERE, sync_service_->GetUserShare());
const syncer::ModelTypeSet encrypted_types = trans.GetEncryptedTypes();
return !encrypted_types.Has(SESSIONS) ||
sync_service_->IsCryptographerReady(&trans);
}
} // namespace browser_sync
|