Upstream version 9.38.198.0
[platform/framework/web/crosswalk.git] / src / extensions / browser / extension_system.h
1 // Copyright 2014 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.
4
5 #ifndef EXTENSIONS_BROWSER_EXTENSION_SYSTEM_H_
6 #define EXTENSIONS_BROWSER_EXTENSION_SYSTEM_H_
7
8 #include <string>
9
10 #include "base/memory/ref_counted.h"
11 #include "components/keyed_service/core/keyed_service.h"
12 #include "extensions/common/extension.h"
13
14 class ExtensionService;
15
16 #if defined(OS_CHROMEOS)
17 namespace chromeos {
18 class DeviceLocalAccountManagementPolicyProvider;
19 }
20 #endif  // defined(OS_CHROMEOS)
21
22 namespace content {
23 class BrowserContext;
24 }
25
26 namespace extensions {
27
28 class Blacklist;
29 class ContentVerifier;
30 class DeclarativeUserScriptMaster;
31 class ErrorConsole;
32 class EventRouter;
33 class Extension;
34 class ExtensionSet;
35 class ExtensionWarningService;
36 class InfoMap;
37 class InstallVerifier;
38 class LazyBackgroundTaskQueue;
39 class ManagementPolicy;
40 class OneShotEvent;
41 class ProcessManager;
42 class QuotaService;
43 class RuntimeData;
44 class SharedUserScriptMaster;
45 class StateStore;
46
47 // ExtensionSystem manages the lifetime of many of the services used by the
48 // extensions and apps system, and it handles startup and shutdown as needed.
49 // Eventually, we'd like to make more of these services into KeyedServices in
50 // their own right.
51 class ExtensionSystem : public KeyedService {
52  public:
53   ExtensionSystem();
54   virtual ~ExtensionSystem();
55
56   // Returns the instance for the given browser context, or NULL if none.
57   static ExtensionSystem* Get(content::BrowserContext* context);
58
59   // Initializes extensions machinery.
60   // Component extensions are always enabled, external and user extensions are
61   // controlled by |extensions_enabled|.
62   virtual void InitForRegularProfile(bool extensions_enabled) = 0;
63
64   // The ExtensionService is created at startup.
65   virtual ExtensionService* extension_service() = 0;
66
67   // Per-extension data that can change during the life of the process but
68   // does not persist across restarts. Lives on UI thread. Created at startup.
69   virtual RuntimeData* runtime_data() = 0;
70
71   // The class controlling whether users are permitted to perform certain
72   // actions on extensions (install, uninstall, disable, etc.).
73   // The ManagementPolicy is created at startup.
74   virtual ManagementPolicy* management_policy() = 0;
75
76   // The SharedUserScriptMaster is created at startup.
77   virtual SharedUserScriptMaster* shared_user_script_master() = 0;
78
79   // The ProcessManager is created at startup.
80   virtual ProcessManager* process_manager() = 0;
81
82   // The StateStore is created at startup.
83   virtual StateStore* state_store() = 0;
84
85   // The rules store is created at startup.
86   virtual StateStore* rules_store() = 0;
87
88   // Returns the IO-thread-accessible extension data.
89   virtual InfoMap* info_map() = 0;
90
91   // The LazyBackgroundTaskQueue is created at startup.
92   virtual LazyBackgroundTaskQueue* lazy_background_task_queue() = 0;
93
94   // The EventRouter is created at startup.
95   virtual EventRouter* event_router() = 0;
96
97   // The ExtensionWarningService is created at startup.
98   virtual ExtensionWarningService* warning_service() = 0;
99
100   // The blacklist is created at startup.
101   virtual Blacklist* blacklist() = 0;
102
103   // The ErrorConsole is created at startup.
104   virtual ErrorConsole* error_console() = 0;
105
106   // The InstallVerifier is created at startup.
107   virtual InstallVerifier* install_verifier() = 0;
108
109   // Returns the QuotaService that limits calls to certain extension functions.
110   // Lives on the UI thread. Created at startup.
111   virtual QuotaService* quota_service() = 0;
112
113   // Called by the ExtensionService that lives in this system. Gives the
114   // info map a chance to react to the load event before the EXTENSION_LOADED
115   // notification has fired. The purpose for handling this event first is to
116   // avoid race conditions by making sure URLRequestContexts learn about new
117   // extensions before anything else needs them to know.
118   virtual void RegisterExtensionWithRequestContexts(
119       const Extension* extension) {}
120
121   // Called by the ExtensionService that lives in this system. Lets the
122   // info map clean up its RequestContexts once all the listeners to the
123   // EXTENSION_UNLOADED notification have finished running.
124   virtual void UnregisterExtensionWithRequestContexts(
125       const std::string& extension_id,
126       const UnloadedExtensionInfo::Reason reason) {}
127
128   // Signaled when the extension system has completed its startup tasks.
129   virtual const OneShotEvent& ready() const = 0;
130
131   // Returns the content verifier, if any.
132   virtual ContentVerifier* content_verifier() = 0;
133
134   // Get a set of extensions that depend on the given extension.
135   // TODO(elijahtaylor): Move SharedModuleService out of chrome/browser
136   // so it can be retrieved from ExtensionSystem directly.
137   virtual scoped_ptr<ExtensionSet> GetDependentExtensions(
138       const Extension* extension) = 0;
139
140   // Get the user script master for declarative scripts, if any.
141   virtual DeclarativeUserScriptMaster*
142       GetDeclarativeUserScriptMasterByExtension(
143           const ExtensionId& extension_id) = 0;
144 };
145
146 }  // namespace extensions
147
148 #endif  // EXTENSIONS_BROWSER_EXTENSION_SYSTEM_H_