158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch// Copyright (c) 2013 The Chromium Authors. All rights reserved. 258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch// Use of this source code is governed by a BSD-style license that can be 358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch// found in the LICENSE file. 458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#ifndef CHROME_BROWSER_CHROMEOS_EXTENSIONS_EXTERNAL_CACHE_H_ 658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#define CHROME_BROWSER_CHROMEOS_EXTENSIONS_EXTERNAL_CACHE_H_ 758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include <string> 958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 1058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/basictypes.h" 114e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/callback_forward.h" 1258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/files/file_path.h" 134e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/gtest_prod_util.h" 144e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/memory/ref_counted.h" 154e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/memory/scoped_ptr.h" 1658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/memory/weak_ptr.h" 174e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/sequenced_task_runner.h" 1858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "chrome/browser/extensions/updater/extension_downloader_delegate.h" 195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "chrome/browser/extensions/updater/local_extension_cache.h" 2058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "content/public/browser/notification_observer.h" 2158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "content/public/browser/notification_registrar.h" 2258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 2358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochnamespace base { 2458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochclass DictionaryValue; 2558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch} 2658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 2758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochnamespace extensions { 2858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochclass ExtensionDownloader; 2958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch} 3058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 3158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochnamespace net { 3258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochclass URLRequestContextGetter; 3358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch} 3458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 3558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochnamespace chromeos { 3658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 374e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// The ExternalCache manages a cache for external extensions. 3858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdochclass ExternalCache : public content::NotificationObserver, 3958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch public extensions::ExtensionDownloaderDelegate { 4058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch public: 411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci typedef base::Callback<void(const std::string& id, bool success)> 421320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci PutExternalExtensionCallback; 431320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 4458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch class Delegate { 4558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch public: 4658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual ~Delegate() {} 4758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Caller owns |prefs|. 4858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual void OnExtensionListsUpdated( 4958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const base::DictionaryValue* prefs) = 0; 50010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Called after extension with |id| is loaded in cache. 51010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) virtual void OnExtensionLoadedInCache(const std::string& id) {} 52010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Called when extension with |id| is failed with downloading for |error|. 53010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) virtual void OnExtensionDownloadFailed( 54010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) const std::string& id, 55010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) extensions::ExtensionDownloaderDelegate::Error error) {} 561e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 571e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // Cache needs to provide already installed extensions otherwise they 581e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // will be removed. Cache calls this function to get version of installed 591e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // extension or empty string if not installed. 601e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) virtual std::string GetInstalledExtensionVersion(const std::string& id); 6158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch }; 6258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 634e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The |request_context| is used for update checks. All file I/O is done via 644e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // the |backend_task_runner|. If |always_check_updates| is |false|, update 654e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // checks are performed for extensions that have an |external_update_url| 664e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // only. If |wait_for_cache_initialization| is |true|, the cache contents will 674e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // not be read until a flag file appears in the cache directory, signaling 684e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // that the cache is ready. 694e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) ExternalCache(const base::FilePath& cache_dir, 7058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch net::URLRequestContextGetter* request_context, 714e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const scoped_refptr<base::SequencedTaskRunner>& 724e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) backend_task_runner, 73ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch Delegate* delegate, 7468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) bool always_check_updates, 754e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool wait_for_cache_initialization); 7658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual ~ExternalCache(); 7758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 78a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // Returns already cached extensions. 79a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) const base::DictionaryValue* cached_extensions() { 80a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) return cached_extensions_.get(); 81a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) } 82a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) 8358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Implementation of content::NotificationObserver: 8458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual void Observe(int type, 8558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const content::NotificationSource& source, 8658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const content::NotificationDetails& details) OVERRIDE; 8758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 8858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Implementation of ExtensionDownloaderDelegate: 8958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual void OnExtensionDownloadFailed( 9058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const std::string& id, 9158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch Error error, 9258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const PingResult& ping_result, 9358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const std::set<int>& request_ids) OVERRIDE; 9458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 9558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual void OnExtensionDownloadFinished( 9658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const std::string& id, 9758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const base::FilePath& path, 985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool file_ownership_passed, 9958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const GURL& download_url, 10058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const std::string& version, 10158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const PingResult& ping_result, 10258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch const std::set<int>& request_ids) OVERRIDE; 10358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 10458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual bool IsExtensionPending(const std::string& id) OVERRIDE; 10558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 10658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch virtual bool GetExtensionExistingVersion(const std::string& id, 10758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch std::string* version) OVERRIDE; 10858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 1094e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Shut down the cache. The |callback| will be invoked when the cache has shut 1104e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // down completely and there are no more pending file I/O operations. 1114e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void Shutdown(const base::Closure& callback); 1124e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1134e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Replace the list of extensions to cache with |prefs| and perform update 1144e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // checks for these. 1154e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void UpdateExtensionsList(scoped_ptr<base::DictionaryValue> prefs); 1164e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 1174e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // If a user of one of the ExternalCache's extensions detects that 1184e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // the extension is damaged then this method can be used to remove it from 1194e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // the cache and retry to download it after a restart. 1204e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void OnDamagedFileDetected(const base::FilePath& path); 12158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 122010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Removes extensions listed in |ids| from external cache, corresponding crx 123010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // files will be removed from disk too. 124010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) void RemoveExtensions(const std::vector<std::string>& ids); 125010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 126cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // If extension with |id| exists in the cache, returns |true|, |file_path| and 127cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // |version| for the extension. Extension will be marked as used with current 128cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // timestamp. 129cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool GetExtension(const std::string& id, 130cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::FilePath* file_path, 131cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) std::string* version); 132cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 1331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Puts the external |crx_file_path| into |local_cache_| for extension with 1341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // |id|. 1351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci void PutExternalExtension(const std::string& id, 1361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const base::FilePath& crx_file_path, 1371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const std::string& version, 1381320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const PutExternalExtensionCallback& callback); 1391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1404e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) private: 14158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Notifies the that the cache has been updated, providing 14258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // extensions loader with an updated list of extensions. 14358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch void UpdateExtensionLoader(); 14458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 1455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Checks the cache contents and initiate download if needed. 1464e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void CheckCache(); 1474e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 14858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Invoked on the UI thread when a new entry has been installed in the cache. 1495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void OnPutExtension(const std::string& id, 1505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const base::FilePath& file_path, 1515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool file_ownership_passed); 15258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 1531320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Invoked on the UI thread when the external extension has been installed 1541320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // in the local cache by calling PutExternalExtension. 1551320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci void OnPutExternalExtension(const std::string& id, 1561320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const PutExternalExtensionCallback& callback, 1571320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const base::FilePath& file_path, 1581320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci bool file_ownership_passed); 1591320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) extensions::LocalExtensionCache local_cache_; 16158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 16258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Request context used by the |downloader_|. 1635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) scoped_refptr<net::URLRequestContextGetter> request_context_; 1645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Task runner for executing file I/O tasks. 1665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const scoped_refptr<base::SequencedTaskRunner> backend_task_runner_; 16758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 16858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Delegate that would like to get notifications about cache updates. 16958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch Delegate* delegate_; 17058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 171ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates needs to be check for the extensions with external_crx too. 172ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool always_check_updates_; 173ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 17468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) // Set to true if cache should wait for initialization flag file. 1754e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool wait_for_cache_initialization_; 17668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 17758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // This is the list of extensions currently configured. 17858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch scoped_ptr<base::DictionaryValue> extensions_; 17958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 18058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // This contains extensions that are both currently configured 18158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // and that have a valid crx in the cache. 18258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch scoped_ptr<base::DictionaryValue> cached_extensions_; 18358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 18458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Used to download the extensions and to check for updates. 18558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch scoped_ptr<extensions::ExtensionDownloader> downloader_; 18658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 18758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch // Observes failures to install CRX files. 18858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch content::NotificationRegistrar notification_registrar_; 18958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 1905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Weak factory for callbacks. 1914e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) base::WeakPtrFactory<ExternalCache> weak_ptr_factory_; 19258e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 19358e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch DISALLOW_COPY_AND_ASSIGN(ExternalCache); 19458e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch}; 19558e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 19658e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch} // namespace chromeos 19758e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch 19858e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#endif // CHROME_BROWSER_CHROMEOS_EXTENSIONS_EXTERNAL_CACHE_H_ 199