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
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_
#define COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_
#include <string>
#include <vector>
#include "base/compiler_specific.h"
#include "components/enhanced_bookmarks/bookmark_server_service.h"
#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
#include "components/signin/core/browser/signin_manager_base.h"
#include "components/sync_driver/sync_service_observer.h"
#include "net/url_request/url_fetcher.h"
class PrefService;
namespace sync_driver {
class SyncService;
}
namespace enhanced_bookmarks {
// Manages requests to the bookmark server to retrieve the current clustering
// state for the bookmarks. A cluster is simply a named set of bookmarks related
// to each others. Invalidates its data when a sync operation finishes.
class BookmarkServerClusterService : public KeyedService,
public BookmarkServerService,
public SigninManagerBase::Observer,
public sync_driver::SyncServiceObserver {
public:
// Maps a cluster name to the stars.id of the bookmarks.
typedef std::map<std::string, std::vector<std::string>> ClusterMap;
// |application_language_code| should be a ISO 639-1 compliant string. Aka
// 'en' or 'en-US'. Note that this code should only specify the language, not
// the locale, so 'en_US' (english language with US locale) and 'en-GB_US'
// (British english person in the US) are not language code.
BookmarkServerClusterService(
const std::string& application_language_code,
scoped_refptr<net::URLRequestContextGetter> request_context_getter,
ProfileOAuth2TokenService* token_service,
SigninManagerBase* signin_manager,
EnhancedBookmarkModel* enhanced_bookmark_model,
sync_driver::SyncService* sync_service,
PrefService* pref_service);
~BookmarkServerClusterService() override;
// KeyedService methods.
void Shutdown() override;
// Retrieves all the bookmarks associated with a cluster. The returned
// BookmarkNodes are owned by the bookmark model, and one must listen to the
// model observer notification to clear them.
const std::vector<const bookmarks::BookmarkNode*> BookmarksForClusterNamed(
const std::string& cluster_name) const;
// Returns the clusters in which the passed bookmark is in, if any.
const std::vector<std::string> ClustersForBookmark(
const bookmarks::BookmarkNode* bookmark) const;
// Dynamically generates a vector of all clusters names.
const std::vector<std::string> GetClusters() const;
// BookmarkServerService methods.
void AddObserver(BookmarkServerServiceObserver* observer) override;
// Registers server cluster service prefs.
static void RegisterPrefs(user_prefs::PrefRegistrySyncable* registry);
protected:
// BookmarkServerService methods.
scoped_ptr<net::URLFetcher> CreateFetcher() override;
bool ProcessResponse(const std::string& response,
bool* should_notify) override;
void CleanAfterFailure() override;
// EnhancedBookmarkModelObserver methods.
void EnhancedBookmarkModelLoaded() override;
void EnhancedBookmarkAdded(const bookmarks::BookmarkNode* node) override;
void EnhancedBookmarkRemoved(const bookmarks::BookmarkNode* node) override;
void EnhancedBookmarkNodeChanged(
const bookmarks::BookmarkNode* node) override;
void EnhancedBookmarkAllUserNodesRemoved() override;
void EnhancedBookmarkRemoteIdChanged(const bookmarks::BookmarkNode* node,
const std::string& old_remote_id,
const std::string& remote_id) override;
private:
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, Cluster);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, SignOut);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, Serialization);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, SaveToPrefs);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, BadAuth);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, EmptyAuth);
FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest,
ClearClusterMapOnRemoveAllBookmarks);
// Overriden from SigninManagerBase::Observer.
void GoogleSignedOut(const std::string& account_id,
const std::string& username) override;
// Updates |cluster_data_| with the |cluster_map| and saves the result to
// profile prefs. All changes to |cluster_data_| should go through this method
// to ensure profile prefs is always up to date.
// TODO(noyau): This is probably a misuse of profile prefs. While the expected
// amount of data is small (<1kb), it can theoretically reach megabytes in
// size.
void SwapModel(ClusterMap* cluster_map);
// Updates |cluster_data_| from profile prefs.
void LoadModel();
// sync_driver::SyncServiceObserver methods.
void OnStateChanged() override;
void OnSyncCycleCompleted() override;
// This sets an internal flag to fetch new clusters.
void InvalidateCache();
// Serialize the |cluster_map| into the returned dictionary value.. The
// |auth_id| uniquely identify the signed in user, to avoid deserializing data
// for a different one.
static scoped_ptr<base::DictionaryValue> Serialize(
const ClusterMap& cluster_map,
const std::string& auth_id);
// Returns true on success.
// The result is swapped into |out_map|.
// |auth_id| must match the serialized auth_id for this method to succeed.
static bool Deserialize(const base::DictionaryValue& value,
const std::string& auth_id,
ClusterMap* out_map);
// The ISO 639-1 code of the language used by the application.
const std::string application_language_code_;
// This class observes the sync service for changes.
sync_driver::SyncService* sync_service_;
// The preferences services associated with the relevant profile.
PrefService* pref_service_;
// The cluster data, a map from cluster name to a vector of stars.id.
ClusterMap cluster_data_;
bool sync_refresh_skipped_;
// This holds the number of cluster refreshes needed.
int refreshes_needed_;
DISALLOW_COPY_AND_ASSIGN(BookmarkServerClusterService);
};
} // namespace enhanced_bookmarks
#endif // COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_
|
