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