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
3 // found in the LICENSE file.
5 #ifndef CHROME_BROWSER_EXTENSIONS_UPDATER_EXTENSION_UPDATER_H_
6 #define CHROME_BROWSER_EXTENSIONS_UPDATER_EXTENSION_UPDATER_H_
14 #include "base/callback_forward.h"
15 #include "base/compiler_specific.h"
16 #include "base/files/file_path.h"
17 #include "base/gtest_prod_util.h"
18 #include "base/memory/scoped_ptr.h"
19 #include "base/memory/weak_ptr.h"
20 #include "base/scoped_observer.h"
21 #include "base/time/time.h"
22 #include "base/timer/timer.h"
23 #include "chrome/browser/extensions/updater/extension_downloader.h"
24 #include "chrome/browser/extensions/updater/extension_downloader_delegate.h"
25 #include "chrome/browser/extensions/updater/manifest_fetch_data.h"
26 #include "content/public/browser/notification_observer.h"
27 #include "content/public/browser/notification_registrar.h"
28 #include "extensions/browser/extension_registry_observer.h"
31 class ExtensionServiceInterface;
39 namespace extensions {
43 class ExtensionRegistry;
45 class ExtensionUpdaterTest;
47 // A class for doing auto-updates of installed Extensions. Used like this:
49 // ExtensionUpdater* updater = new ExtensionUpdater(my_extensions_service,
53 // update_frequency_secs,
54 // downloader_factory);
58 class ExtensionUpdater : public ExtensionDownloaderDelegate,
59 public ExtensionRegistryObserver,
60 public content::NotificationObserver {
62 typedef base::Closure FinishedCallback;
65 // Creates a default CheckParams instance that checks for all extensions.
69 // The set of extensions that should be checked for updates. If empty
70 // all extensions will be included in the update check.
71 std::list<std::string> ids;
73 // Normally extension updates get installed only when the extension is idle.
74 // Setting this to true causes any updates that are found to be installed
76 bool install_immediately;
78 // Callback to call when the update check is complete. Can be null, if
79 // you're not interested in when this happens.
80 FinishedCallback callback;
83 // Holds a pointer to the passed |service|, using it for querying installed
84 // extensions and installing updated ones. The |frequency_seconds| parameter
85 // controls how often update checks are scheduled.
86 ExtensionUpdater(ExtensionServiceInterface* service,
87 ExtensionPrefs* extension_prefs,
90 int frequency_seconds,
91 ExtensionCache* cache,
92 const ExtensionDownloader::Factory& downloader_factory);
94 virtual ~ExtensionUpdater();
96 // Starts the updater running. Should be called at most once.
99 // Stops the updater running, cancelling any outstanding update manifest and
100 // crx downloads. Does not cancel any in-progress installs.
103 // Posts a task to do an update check. Does nothing if there is
104 // already a pending task that has not yet run.
107 // Starts an update check for the specified extension soon. If a check
108 // is already running, or finished too recently without an update being
109 // installed, this method returns false and the check won't be scheduled.
110 bool CheckExtensionSoon(const std::string& extension_id,
111 const FinishedCallback& callback);
113 // Starts an update check right now, instead of waiting for the next
114 // regularly scheduled check or a pending check from CheckSoon().
115 void CheckNow(const CheckParams& params);
117 // Returns true iff CheckSoon() has been called but the update check
118 // hasn't been performed yet. This is used mostly by tests; calling
119 // code should just call CheckSoon().
120 bool WillCheckSoon() const;
122 // Changes the params that are used for the automatic periodic update checks,
123 // as well as for explicit calls to CheckSoon.
124 void set_default_check_params(const CheckParams& params) {
125 default_params_ = params;
129 friend class ExtensionUpdaterTest;
130 friend class ExtensionUpdaterFileHandler;
132 // FetchedCRXFile holds information about a CRX file we fetched to disk,
133 // but have not yet installed.
134 struct FetchedCRXFile {
136 FetchedCRXFile(const std::string& id,
137 const base::FilePath& path,
138 bool file_ownership_passed,
139 const std::set<int>& request_ids);
142 std::string extension_id;
144 bool file_ownership_passed;
145 std::set<int> request_ids;
148 struct InProgressCheck {
152 bool install_immediately;
153 FinishedCallback callback;
154 // The ids of extensions that have in-progress update checks.
155 std::list<std::string> in_progress_ids_;
160 // Ensure that we have a valid ExtensionDownloader instance referenced by
162 void EnsureDownloaderCreated();
164 // Computes when to schedule the first update check.
165 base::TimeDelta DetermineFirstCheckDelay();
167 // Sets the timer to call TimerFired after roughly |target_delay| from now.
168 // To help spread load evenly on servers, this method adds some random
169 // jitter. It also saves the scheduled time so it can be reloaded on
171 void ScheduleNextCheck(const base::TimeDelta& target_delay);
173 // Add fetch records for extensions that are installed to the downloader,
174 // ignoring |pending_ids| so the extension isn't fetched again.
175 void AddToDownloader(const ExtensionSet* extensions,
176 const std::list<std::string>& pending_ids,
179 // BaseTimer::ReceiverMethod callback.
182 // Posted by CheckSoon().
185 // Implementation of ExtensionDownloaderDelegate.
186 virtual void OnExtensionDownloadFailed(
187 const std::string& id,
189 const PingResult& ping,
190 const std::set<int>& request_ids) OVERRIDE;
192 virtual void OnExtensionDownloadFinished(
193 const std::string& id,
194 const base::FilePath& path,
195 bool file_ownership_passed,
196 const GURL& download_url,
197 const std::string& version,
198 const PingResult& ping,
199 const std::set<int>& request_id) OVERRIDE;
201 // Implementation of ExtensionRegistryObserver.
202 virtual void OnExtensionWillBeInstalled(
203 content::BrowserContext* browser_context,
204 const Extension* extension,
207 const std::string& old_name) OVERRIDE;
209 virtual bool GetPingDataForExtension(
210 const std::string& id,
211 ManifestFetchData::PingData* ping_data) OVERRIDE;
213 virtual std::string GetUpdateUrlData(const std::string& id) OVERRIDE;
215 virtual bool IsExtensionPending(const std::string& id) OVERRIDE;
217 virtual bool GetExtensionExistingVersion(const std::string& id,
218 std::string* version) OVERRIDE;
220 void UpdatePingData(const std::string& id, const PingResult& ping_result);
222 // Starts installing a crx file that has been fetched but not installed yet.
223 void MaybeInstallCRXFile();
225 // content::NotificationObserver implementation.
226 virtual void Observe(int type,
227 const content::NotificationSource& source,
228 const content::NotificationDetails& details) OVERRIDE;
230 // Send a notification that update checks are starting.
231 void NotifyStarted();
233 // Send a notification if we're finished updating.
234 void NotifyIfFinished(int request_id);
236 void ExtensionCheckFinished(const std::string& extension_id,
237 const FinishedCallback& callback);
239 // Whether Start() has been called but not Stop().
242 base::WeakPtrFactory<ExtensionUpdater> weak_ptr_factory_;
244 // Pointer back to the service that owns this ExtensionUpdater.
245 ExtensionServiceInterface* service_;
247 // A closure passed into the ExtensionUpdater to teach it how to construct
248 // new ExtensionDownloader instances.
249 const ExtensionDownloader::Factory downloader_factory_;
251 // Fetches the crx files for the extensions that have an available update.
252 scoped_ptr<ExtensionDownloader> downloader_;
254 base::OneShotTimer<ExtensionUpdater> timer_;
255 int frequency_seconds_;
256 bool will_check_soon_;
258 ExtensionPrefs* extension_prefs_;
262 std::map<int, InProgressCheck> requests_in_progress_;
263 int next_request_id_;
265 // Observes CRX installs we initiate.
266 content::NotificationRegistrar registrar_;
268 ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
269 extension_registry_observer_;
271 // True when a CrxInstaller is doing an install. Used in MaybeUpdateCrxFile()
272 // to keep more than one install from running at once.
273 bool crx_install_is_running_;
275 // Fetched CRX files waiting to be installed.
276 std::stack<FetchedCRXFile> fetched_crx_files_;
277 FetchedCRXFile current_crx_file_;
279 CheckParams default_params_;
281 ExtensionCache* extension_cache_;
283 // Keeps track of when an extension tried to update itself, so we can throttle
284 // checks to prevent too many requests from being made.
285 std::map<std::string, ThrottleInfo> throttle_info_;
287 DISALLOW_COPY_AND_ASSIGN(ExtensionUpdater);
290 } // namespace extensions
292 #endif // CHROME_BROWSER_EXTENSIONS_UPDATER_EXTENSION_UPDATER_H_