Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(345)

Side by Side Diff: chrome/browser/chrome_to_mobile_service.h

Issue 10834203: Integrate invalidation API into ChromeToMobileService. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Address comments. Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_ 5 #ifndef CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_
6 #define CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_ 6 #define CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_
7 7
8 #include <map> 8 #include <map>
9 #include <set> 9 #include <set>
10 #include <queue>
sky 2012/08/20 23:14:03 nit: sort
msw 2012/08/21 03:37:01 Done.
10 #include <string> 11 #include <string>
11 #include <vector> 12 #include <vector>
12 13
14 #include "base/compiler_specific.h"
13 #include "base/file_path.h" 15 #include "base/file_path.h"
14 #include "base/memory/weak_ptr.h" 16 #include "base/memory/weak_ptr.h"
15 #include "base/string16.h" 17 #include "base/string16.h"
16 #include "base/timer.h" 18 #include "base/timer.h"
17 #include "base/values.h" 19 #include "base/values.h"
18 #include "chrome/browser/profiles/profile_keyed_service.h" 20 #include "chrome/browser/profiles/profile_keyed_service.h"
19 #include "chrome/browser/sessions/session_id.h" 21 #include "chrome/browser/sessions/session_id.h"
22 #include "chrome/browser/sync/profile_sync_service_observer.h"
20 #include "chrome/common/net/gaia/oauth2_access_token_consumer.h" 23 #include "chrome/common/net/gaia/oauth2_access_token_consumer.h"
21 #include "content/public/browser/notification_observer.h" 24 #include "content/public/browser/notification_observer.h"
22 #include "content/public/browser/notification_registrar.h" 25 #include "content/public/browser/notification_registrar.h"
23 #include "googleurl/src/gurl.h" 26 #include "googleurl/src/gurl.h"
24 #include "net/url_request/url_fetcher_delegate.h" 27 #include "net/url_request/url_fetcher_delegate.h"
28 #include "sync/notifier/sync_notifier_observer.h"
25 29
26 class OAuth2AccessTokenFetcher; 30 class OAuth2AccessTokenFetcher;
27 class Browser; 31 class Browser;
28 class CloudPrintURL; 32 class CloudPrintURL;
29 class MockChromeToMobileService; 33 class MockChromeToMobileService;
30 class PrefService; 34 class PrefService;
31 class Profile; 35 class Profile;
32 36
33 namespace net { 37 namespace net {
34 class URLFetcher; 38 class URLFetcher;
35 } 39 }
36 40
37 // ChromeToMobileService connects to the cloud print service to enumerate 41 // ChromeToMobileService connects to the cloud print service to enumerate
38 // compatible mobiles owned by its profile and send URLs and MHTML snapshots. 42 // compatible mobiles owned by its profile and send URLs and MHTML snapshots.
39 class ChromeToMobileService : public ProfileKeyedService, 43 class ChromeToMobileService : public ProfileKeyedService,
40 public net::URLFetcherDelegate, 44 public net::URLFetcherDelegate,
41 public content::NotificationObserver, 45 public content::NotificationObserver,
42 public OAuth2AccessTokenConsumer { 46 public OAuth2AccessTokenConsumer,
47 public ProfileSyncServiceObserver,
48 public syncer::SyncNotifierObserver {
43 public: 49 public:
44 class Observer { 50 class Observer {
45 public: 51 public:
46 virtual ~Observer(); 52 virtual ~Observer();
47 53
48 // Called on generation of the page's MHTML snapshot. 54 // Called on generation of the page's MHTML snapshot.
49 virtual void SnapshotGenerated(const FilePath& path, int64 bytes) = 0; 55 virtual void SnapshotGenerated(const FilePath& path, int64 bytes) = 0;
50 56
51 // Called after URLFetcher responses from sending the URL (and snapshot). 57 // Called after URLFetcher responses from sending the URL (and snapshot).
52 virtual void OnSendComplete(bool success) = 0; 58 virtual void OnSendComplete(bool success) = 0;
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
105 111
106 // Returns true if the service has found any registered mobile devices. 112 // Returns true if the service has found any registered mobile devices.
107 bool HasMobiles() const; 113 bool HasMobiles() const;
108 114
109 // Get the non-NULL ListValue of mobile devices from the cloud print service. 115 // Get the non-NULL ListValue of mobile devices from the cloud print service.
110 // The list is owned by PrefService, which outlives ChromeToMobileService. 116 // The list is owned by PrefService, which outlives ChromeToMobileService.
111 // Each device DictionaryValue contains strings "type", "name", and "id". 117 // Each device DictionaryValue contains strings "type", "name", and "id".
112 // Virtual for unit test mocking. 118 // Virtual for unit test mocking.
113 virtual const base::ListValue* GetMobiles() const; 119 virtual const base::ListValue* GetMobiles() const;
114 120
115 // Request an updated mobile device list, request auth first if needed.
116 // Virtual for unit test mocking.
117 virtual void RequestMobileListUpdate();
118
119 // Callback with an MHTML snapshot of the browser's selected WebContents. 121 // Callback with an MHTML snapshot of the browser's selected WebContents.
120 // Virtual for unit test mocking. 122 // Virtual for unit test mocking.
121 virtual void GenerateSnapshot(Browser* browser, 123 virtual void GenerateSnapshot(Browser* browser,
122 base::WeakPtr<Observer> observer); 124 base::WeakPtr<Observer> observer);
123 125
124 // Send the browser's selected WebContents to the specified mobile device. 126 // Send the browser's selected WebContents to the specified mobile device.
125 // Virtual for unit test mocking. 127 // Virtual for unit test mocking.
126 virtual void SendToMobile(const base::DictionaryValue& mobile, 128 virtual void SendToMobile(const base::DictionaryValue* mobile,
127 const FilePath& snapshot, 129 const FilePath& snapshot,
128 Browser* browser, 130 Browser* browser,
129 base::WeakPtr<Observer> observer); 131 base::WeakPtr<Observer> observer);
130 132
131 // Delete the snapshot file (should be called on observer destruction). 133 // Delete the snapshot file (should be called on observer destruction).
132 // Virtual for unit test mocking. 134 // Virtual for unit test mocking.
133 virtual void DeleteSnapshot(const FilePath& snapshot); 135 virtual void DeleteSnapshot(const FilePath& snapshot);
134 136
135 // Log a metric for the "ChromeToMobile.Service" histogram. 137 // Log a metric for the "ChromeToMobile.Service" histogram.
136 // Virtual for unit test mocking. 138 // Virtual for unit test mocking.
137 virtual void LogMetric(Metric metric) const; 139 virtual void LogMetric(Metric metric) const;
138 140
139 // Opens the "Learn More" help article link in the supplied |browser|. 141 // Opens the "Learn More" help article link in the supplied |browser|.
140 void LearnMore(Browser* browser) const; 142 void LearnMore(Browser* browser) const;
141 143
142 // net::URLFetcherDelegate method. 144 // net::URLFetcherDelegate method.
143 virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE; 145 virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;
144 146
145 // content::NotificationObserver method. 147 // content::NotificationObserver method.
146 virtual void Observe(int type, 148 virtual void Observe(int type,
147 const content::NotificationSource& source, 149 const content::NotificationSource& source,
148 const content::NotificationDetails& details) OVERRIDE; 150 const content::NotificationDetails& details) OVERRIDE;
149 151
150 // OAuth2AccessTokenConsumer methods. 152 // OAuth2AccessTokenConsumer methods.
151 virtual void OnGetTokenSuccess(const std::string& access_token, 153 virtual void OnGetTokenSuccess(const std::string& access_token,
152 const base::Time& expiration_time) OVERRIDE; 154 const base::Time& expiration_time) OVERRIDE;
153 virtual void OnGetTokenFailure(const GoogleServiceAuthError& error) OVERRIDE; 155 virtual void OnGetTokenFailure(const GoogleServiceAuthError& error) OVERRIDE;
154 156
157 // ProfileSyncServiceObserver implementation.
158 virtual void OnStateChanged() OVERRIDE;
159
160 // syncer::SyncNotifierObserver implementation.
161 virtual void OnNotificationsEnabled() OVERRIDE;
162 virtual void OnNotificationsDisabled(
163 syncer::NotificationsDisabledReason reason) OVERRIDE;
164 virtual void OnIncomingNotification(
165 const syncer::ObjectIdPayloadMap& id_payloads,
166 syncer::IncomingNotificationSource source) OVERRIDE;
167
168 // Expose access token accessors for test purposes.
169 const std::string& GetAccessTokenForTest() const;
170 void SetAccessTokenForTest(const std::string& access_token);
171
155 private: 172 private:
156 friend class MockChromeToMobileService; 173 friend class MockChromeToMobileService;
157 174
158 // Enable or disable Chrome To Mobile with the browsers' command controllers. 175 // Enable or disable Chrome To Mobile with the browsers' command controllers.
159 // The feature state is automatically derived from internal conditions. 176 // The feature state is automatically derived from internal conditions.
160 void UpdateCommandState() const; 177 void UpdateCommandState() const;
161 178
162 // Handle the attempted creation of a temporary file for snapshot generation. 179 // Handle the attempted creation of a temporary file for snapshot generation.
163 // Alert the observer of failure or generate MHTML with an observer callback. 180 // Alert the observer of failure or generate MHTML with an observer callback.
164 void SnapshotFileCreated(base::WeakPtr<Observer> observer, 181 void SnapshotFileCreated(base::WeakPtr<Observer> observer,
165 SessionID::id_type browser_id, 182 SessionID::id_type browser_id,
166 const FilePath& path, 183 const FilePath& path,
167 bool success); 184 bool success);
168 185
169 // Create a cloud print job submission request for a URL or snapshot. 186 // Create a cloud print job submission request for a URL or snapshot.
170 net::URLFetcher* CreateRequest(const JobData& data); 187 net::URLFetcher* CreateRequest(const JobData& data);
171 188
172 // Initialize cloud print URLFetcher requests. 189 // Initialize cloud print URLFetcher requests.
173 void InitRequest(net::URLFetcher* request); 190 void InitRequest(net::URLFetcher* request);
174 191
175 // Submit a cloud print job request with the requisite data. 192 // Submit a cloud print job request with the requisite data.
176 void SendRequest(net::URLFetcher* request, const JobData& data); 193 void SendRequest(net::URLFetcher* request, const JobData& data);
177 194
178 // Send the OAuth2AccessTokenFetcher request. 195 // Send the OAuth2AccessTokenFetcher request.
179 // Virtual for unit test mocking. 196 // Virtual for unit test mocking.
180 virtual void RequestAccessToken(); 197 virtual void RequestAccessToken();
181 198
182 // Request account information to limit cloud print access to existing users. 199 // Send the cloud print URLFetcher device search request.
183 void RequestAccountInfo(); 200 // Virtual for unit test mocking.
201 virtual void RequestDeviceSearch();
184 202
185 // Send the cloud print URLFetcher device search request.
186 void RequestDeviceSearch();
187
188 void HandleAccountInfoResponse();
189 void HandleSearchResponse(); 203 void HandleSearchResponse();
190 void HandleSubmitResponse(const net::URLFetcher* source); 204 void HandleSubmitResponse(const net::URLFetcher* source);
191 205
192 base::WeakPtrFactory<ChromeToMobileService> weak_ptr_factory_; 206 base::WeakPtrFactory<ChromeToMobileService> weak_ptr_factory_;
193 207
194 Profile* profile_; 208 Profile* profile_;
195 209
210 // Sync service states. Profile Sync Service and Sync Invalidations are needed
211 // to keep the mobile device list up to date and prevent page send failures.
212 bool profile_sync_service_enabled_;
213 bool sync_invalidation_enabled_;
214
196 // Used to recieve TokenService notifications for GaiaOAuth2LoginRefreshToken. 215 // Used to recieve TokenService notifications for GaiaOAuth2LoginRefreshToken.
197 content::NotificationRegistrar registrar_; 216 content::NotificationRegistrar registrar_;
198 217
199 // Cloud print helper class and auth token. 218 // Cloud print helper class and auth token.
200 scoped_ptr<CloudPrintURL> cloud_print_url_; 219 scoped_ptr<CloudPrintURL> cloud_print_url_;
201 std::string access_token_; 220 std::string access_token_;
202 221
203 // The set of snapshots currently available. 222 // The set of snapshots currently available.
204 std::set<FilePath> snapshots_; 223 std::set<FilePath> snapshots_;
205 224
206 // Map URLFetchers to observers for reporting OnSendComplete. 225 // Map URLFetchers to observers for reporting OnSendComplete.
207 typedef std::map<const net::URLFetcher*, base::WeakPtr<Observer> > 226 typedef std::map<const net::URLFetcher*, base::WeakPtr<Observer> >
208 RequestObserverMap; 227 RequestObserverMap;
209 RequestObserverMap request_observer_map_; 228 RequestObserverMap request_observer_map_;
210 229
211 // The pending OAuth access token request and a timer for retrying on failure. 230 // The pending OAuth access token request and a timer for retrying on failure.
212 scoped_ptr<OAuth2AccessTokenFetcher> access_token_fetcher_; 231 scoped_ptr<OAuth2AccessTokenFetcher> access_token_fetcher_;
213 base::OneShotTimer<ChromeToMobileService> auth_retry_timer_; 232 base::OneShotTimer<ChromeToMobileService> auth_retry_timer_;
214 233
215 // The pending account information request and the cloud print access flag.
216 scoped_ptr<net::URLFetcher> account_info_request_;
217 bool cloud_print_accessible_;
218
219 // The pending mobile device search request. 234 // The pending mobile device search request.
220 scoped_ptr<net::URLFetcher> search_request_; 235 scoped_ptr<net::URLFetcher> search_request_;
221 236
237 // A queue of tasks to perform after an access token is lazily initialized.
238 std::queue<base::Closure> task_queue_;
239
222 DISALLOW_COPY_AND_ASSIGN(ChromeToMobileService); 240 DISALLOW_COPY_AND_ASSIGN(ChromeToMobileService);
223 }; 241 };
224 242
225 #endif // CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_ 243 #endif // CHROME_BROWSER_CHROME_TO_MOBILE_SERVICE_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698