blob: 4c3572c5ce6cfdc46a9cf9fc155db17595018d75 [file] [log] [blame]
[email protected]f3d3b382014-03-14 21:19:281// Copyright 2014 The Chromium Authors. All rights reserved.
[email protected]b2907fd2011-03-25 16:43:372// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
[email protected]f3d3b382014-03-14 21:19:285#ifndef CHROME_BROWSER_EXTENSIONS_PENDING_EXTENSION_MANAGER_H_
6#define CHROME_BROWSER_EXTENSIONS_PENDING_EXTENSION_MANAGER_H_
[email protected]b2907fd2011-03-25 16:43:377
[email protected]51a3bf8b2012-06-08 22:53:068#include <list>
[email protected]b2907fd2011-03-25 16:43:379#include <string>
10
[email protected]f3d3b382014-03-14 21:19:2811#include "chrome/browser/extensions/pending_extension_info.h"
[email protected]d42c11152013-08-22 19:36:3212#include "extensions/common/manifest.h"
[email protected]b2907fd2011-03-25 16:43:3713
[email protected]2859946f2011-04-04 18:18:0614class ExtensionServiceInterface;
[email protected]b2907fd2011-03-25 16:43:3715class GURL;
[email protected]1f04ef42013-04-22 07:35:5016
17namespace base {
[email protected]e3987852012-05-04 10:06:3018class Version;
[email protected]1f04ef42013-04-22 07:35:5019}
[email protected]42a08162012-03-16 18:09:1120
[email protected]3f213ad2012-07-26 23:39:4121FORWARD_DECLARE_TEST(ExtensionServiceTest,
22 UpdatePendingExtensionAlreadyInstalled);
23
[email protected]42a08162012-03-16 18:09:1124namespace extensions {
[email protected]b52f8ca2013-11-28 08:25:2225class Extension;
26class PendingExtensionManager;
27
[email protected]42a08162012-03-16 18:09:1128class ExtensionUpdaterTest;
29void SetupPendingExtensionManagerForTest(
30 int count, const GURL& update_url,
31 PendingExtensionManager* pending_extension_manager);
[email protected]b2907fd2011-03-25 16:43:3732
33// Class PendingExtensionManager manages the set of extensions which are
[email protected]75764512011-12-19 19:54:2834// being installed or updated. In general, installation and updates take
[email protected]b2907fd2011-03-25 16:43:3735// time, because they involve downloading, unpacking, and installing.
36// This class allows us to avoid race cases where multiple sources install
37// the same extension.
38// The extensions service creates an instance of this class, and manages
39// its lifetime. This class should only be used from the UI thread.
40class PendingExtensionManager {
41 public:
[email protected]b2907fd2011-03-25 16:43:3742 // |service| is a reference to the ExtensionService whose pending
43 // extensions we are managing. The service creates an instance of
44 // this class on construction, and destroys it on destruction.
45 // The service remains valid over the entire lifetime of this class.
[email protected]2859946f2011-04-04 18:18:0646 explicit PendingExtensionManager(const ExtensionServiceInterface& service);
[email protected]b2907fd2011-03-25 16:43:3747 ~PendingExtensionManager();
48
49 // TODO(skerner): Many of these methods can be private once code in
50 // ExtensionService is moved into methods of this class.
51
[email protected]51a3bf8b2012-06-08 22:53:0652 // Remove extension with id |id| from the set of pending extensions. Returns
53 // true if such an extension was found and removed, false otherwise.
54 bool Remove(const std::string& id);
[email protected]b2907fd2011-03-25 16:43:3755
[email protected]51a3bf8b2012-06-08 22:53:0656 // Get the information for a pending extension. Returns a pointer to the
57 // pending extension with id |id|, or NULL if there is no such extension.
58 const PendingExtensionInfo* GetById(const std::string& id) const;
[email protected]b2907fd2011-03-25 16:43:3759
60 // Is |id| in the set of pending extensions?
61 bool IsIdPending(const std::string& id) const;
62
[email protected]9bd9a6862012-11-29 09:24:2263 // Returns true if there are any extensions pending.
64 bool HasPendingExtensions() const;
65
[email protected]d31e19e2012-08-22 00:19:0466 // Whether there is pending extension install from sync.
67 bool HasPendingExtensionFromSync() const;
68
[email protected]b2907fd2011-03-25 16:43:3769 // Adds an extension in a pending state; the extension with the
70 // given info will be installed on the next auto-update cycle.
[email protected]145a317b2011-04-12 16:03:4671 // Return true if the extension was added. Will return false
72 // if the extension is pending from another source which overrides
73 // sync installs (such as a policy extension) or if the extension
74 // is already installed.
[email protected]b2907fd2011-03-25 16:43:3775 //
76 // TODO(akalin): Replace |install_silently| with a list of
77 // pre-enabled permissions.
[email protected]145a317b2011-04-12 16:03:4678 bool AddFromSync(
[email protected]b2907fd2011-03-25 16:43:3779 const std::string& id,
80 const GURL& update_url,
81 PendingExtensionInfo::ShouldAllowInstallPredicate should_allow_install,
[email protected]6cc7dbae2011-04-29 21:18:3382 bool install_silently);
[email protected]b2907fd2011-03-25 16:43:3783
[email protected]9f4e4f082013-06-21 07:11:1984 // Adds an extension that was depended on by another extension.
85 bool AddFromExtensionImport(
86 const std::string& id,
87 const GURL& update_url,
88 PendingExtensionInfo::ShouldAllowInstallPredicate should_allow_install);
89
[email protected]b2907fd2011-03-25 16:43:3790 // Given an extension id and an update URL, schedule the extension
91 // to be fetched, installed, and activated.
[email protected]9060d8b02012-01-13 02:14:3092 bool AddFromExternalUpdateUrl(const std::string& id,
[email protected]b2907fd2011-03-25 16:43:3793 const GURL& update_url,
[email protected]464213a2013-10-15 01:06:4894 Manifest::Location location,
95 int creation_flags,
96 bool mark_acknowledged);
[email protected]b2907fd2011-03-25 16:43:3797
[email protected]b2907fd2011-03-25 16:43:3798 // Add a pending extension record for an external CRX file.
[email protected]9060d8b02012-01-13 02:14:3099 // Return true if the CRX should be installed, false if an existing
100 // pending record overrides it.
101 bool AddFromExternalFile(
[email protected]b2907fd2011-03-25 16:43:37102 const std::string& id,
[email protected]1d5e58b2013-01-31 08:41:40103 Manifest::Location location,
[email protected]464213a2013-10-15 01:06:48104 const base::Version& version,
105 int creation_flags,
106 bool mark_acknowledged);
[email protected]b2907fd2011-03-25 16:43:37107
[email protected]51a3bf8b2012-06-08 22:53:06108 // Get the list of pending IDs that should be installed from an update URL.
[email protected]9060d8b02012-01-13 02:14:30109 // Pending extensions that will be installed from local files will not be
110 // included in the set.
111 void GetPendingIdsForUpdateCheck(
[email protected]51a3bf8b2012-06-08 22:53:06112 std::list<std::string>* out_ids_for_update_check) const;
[email protected]9060d8b02012-01-13 02:14:30113
[email protected]b2907fd2011-03-25 16:43:37114 private:
[email protected]51a3bf8b2012-06-08 22:53:06115 typedef std::list<PendingExtensionInfo> PendingExtensionList;
[email protected]9060d8b02012-01-13 02:14:30116
[email protected]b2907fd2011-03-25 16:43:37117 // Assumes an extension with id |id| is not already installed.
[email protected]145a317b2011-04-12 16:03:46118 // Return true if the extension was added.
119 bool AddExtensionImpl(
[email protected]b2907fd2011-03-25 16:43:37120 const std::string& id,
121 const GURL& update_url,
[email protected]1f04ef42013-04-22 07:35:50122 const base::Version& version,
[email protected]b2907fd2011-03-25 16:43:37123 PendingExtensionInfo::ShouldAllowInstallPredicate should_allow_install,
124 bool is_from_sync,
125 bool install_silently,
[email protected]464213a2013-10-15 01:06:48126 Manifest::Location install_source,
127 int creation_flags,
128 bool mark_acknowledged);
[email protected]b2907fd2011-03-25 16:43:37129
130 // Add a pending extension record directly. Used for unit tests that need
131 // to set an inital state. Use friendship to allow the tests to call this
132 // method.
[email protected]51a3bf8b2012-06-08 22:53:06133 void AddForTesting(const PendingExtensionInfo& pending_extension_info);
[email protected]b2907fd2011-03-25 16:43:37134
135 // Reference to the extension service whose pending extensions this class is
136 // managing. Because this class is a member of |service_|, it is created
137 // and destroyed with |service_|. We only use methods from the interface
[email protected]2859946f2011-04-04 18:18:06138 // ExtensionServiceInterface.
139 const ExtensionServiceInterface& service_;
[email protected]b2907fd2011-03-25 16:43:37140
[email protected]51a3bf8b2012-06-08 22:53:06141 PendingExtensionList pending_extension_list_;
[email protected]b2907fd2011-03-25 16:43:37142
[email protected]3f213ad2012-07-26 23:39:41143 FRIEND_TEST_ALL_PREFIXES(::ExtensionServiceTest,
[email protected]b2907fd2011-03-25 16:43:37144 UpdatePendingExtensionAlreadyInstalled);
[email protected]3f213ad2012-07-26 23:39:41145 friend class ExtensionUpdaterTest;
146 friend void SetupPendingExtensionManagerForTest(
[email protected]b2907fd2011-03-25 16:43:37147 int count, const GURL& update_url,
148 PendingExtensionManager* pending_extension_manager);
149
150 DISALLOW_COPY_AND_ASSIGN(PendingExtensionManager);
151};
152
[email protected]3f213ad2012-07-26 23:39:41153} // namespace extensions
154
[email protected]f3d3b382014-03-14 21:19:28155#endif // CHROME_BROWSER_EXTENSIONS_PENDING_EXTENSION_MANAGER_H_