1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_API_RUNTIME_RUNTIME_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_RUNTIME_RUNTIME_API_H_
#include <string>
#include "chrome/browser/extensions/chrome_extension_function.h"
#include "chrome/common/extensions/api/runtime.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "extensions/browser/browser_context_keyed_api_factory.h"
#include "extensions/browser/update_observer.h"
class Profile;
namespace base {
class Version;
}
namespace content {
class BrowserContext;
}
namespace extensions {
class Extension;
class ExtensionHost;
// Runtime API dispatches onStartup, onInstalled, and similar events to
// extensions. There is one instance shared between a browser context and
// its related incognito instance.
class RuntimeAPI : public BrowserContextKeyedAPI,
public content::NotificationObserver,
public extensions::UpdateObserver {
public:
static BrowserContextKeyedAPIFactory<RuntimeAPI>* GetFactoryInstance();
explicit RuntimeAPI(content::BrowserContext* context);
virtual ~RuntimeAPI();
// content::NotificationObserver overrides:
virtual void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) OVERRIDE;
private:
friend class BrowserContextKeyedAPIFactory<RuntimeAPI>;
void OnExtensionsReady();
void OnExtensionLoaded(const Extension* extension);
void OnExtensionInstalled(const Extension* extension);
void OnExtensionUninstalled(const Extension* extension);
// BrowserContextKeyedAPI implementation:
static const char* service_name() { return "RuntimeAPI"; }
static const bool kServiceRedirectedInIncognito = true;
static const bool kServiceIsNULLWhileTesting = true;
// extensions::UpdateObserver overrides:
virtual void OnAppUpdateAvailable(const Extension* extension) OVERRIDE;
virtual void OnChromeUpdateAvailable() OVERRIDE;
content::BrowserContext* browser_context_;
// True if we should dispatch the chrome.runtime.onInstalled event with
// reason "chrome_update" upon loading each extension.
bool dispatch_chrome_updated_event_;
// Whether the API registered with the ExtensionService to receive
// update notifications.
bool registered_for_updates_;
content::NotificationRegistrar registrar_;
DISALLOW_COPY_AND_ASSIGN(RuntimeAPI);
};
class RuntimeEventRouter {
public:
// Dispatches the onStartup event to all currently-loaded extensions.
static void DispatchOnStartupEvent(content::BrowserContext* context,
const std::string& extension_id);
// Dispatches the onInstalled event to the given extension.
static void DispatchOnInstalledEvent(content::BrowserContext* context,
const std::string& extension_id,
const base::Version& old_version,
bool chrome_updated);
// Dispatches the onUpdateAvailable event to the given extension.
static void DispatchOnUpdateAvailableEvent(
Profile* profile,
const std::string& extension_id,
const base::DictionaryValue* manifest);
// Dispatches the onBrowserUpdateAvailable event to all extensions.
static void DispatchOnBrowserUpdateAvailableEvent(Profile* profile);
// Dispatches the onRestartRequired event to the given app.
static void DispatchOnRestartRequiredEvent(
Profile* profile,
const std::string& app_id,
api::runtime::OnRestartRequired::Reason reason);
// Does any work needed at extension uninstall (e.g. load uninstall url).
static void OnExtensionUninstalled(Profile* profile,
const std::string& extension_id);
};
class RuntimeGetBackgroundPageFunction : public ChromeAsyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.getBackgroundPage",
RUNTIME_GETBACKGROUNDPAGE)
protected:
virtual ~RuntimeGetBackgroundPageFunction() {}
virtual bool RunImpl() OVERRIDE;
private:
void OnPageLoaded(ExtensionHost*);
};
class RuntimeSetUninstallURLFunction : public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.setUninstallURL",
RUNTIME_SETUNINSTALLURL)
protected:
virtual ~RuntimeSetUninstallURLFunction() {}
virtual bool RunImpl() OVERRIDE;
};
class RuntimeReloadFunction : public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.reload", RUNTIME_RELOAD)
protected:
virtual ~RuntimeReloadFunction() {}
virtual bool RunImpl() OVERRIDE;
};
class RuntimeRequestUpdateCheckFunction : public ChromeAsyncExtensionFunction,
public content::NotificationObserver {
public:
DECLARE_EXTENSION_FUNCTION("runtime.requestUpdateCheck",
RUNTIME_REQUESTUPDATECHECK)
RuntimeRequestUpdateCheckFunction();
protected:
virtual ~RuntimeRequestUpdateCheckFunction() {}
virtual bool RunImpl() OVERRIDE;
// Implements content::NotificationObserver interface.
virtual void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) OVERRIDE;
private:
void CheckComplete();
void ReplyUpdateFound(const std::string& version);
content::NotificationRegistrar registrar_;
bool did_reply_;
};
class RuntimeRestartFunction : public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.restart", RUNTIME_RESTART)
protected:
virtual ~RuntimeRestartFunction() {}
virtual bool RunImpl() OVERRIDE;
};
class RuntimeGetPlatformInfoFunction : public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.getPlatformInfo",
RUNTIME_GETPLATFORMINFO);
protected:
virtual ~RuntimeGetPlatformInfoFunction() {}
virtual bool RunImpl() OVERRIDE;
};
class RuntimeGetPackageDirectoryEntryFunction
: public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("runtime.getPackageDirectoryEntry",
RUNTIME_GETPACKAGEDIRECTORYENTRY)
protected:
virtual ~RuntimeGetPackageDirectoryEntryFunction() {}
virtual bool RunImpl() OVERRIDE;
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_RUNTIME_RUNTIME_API_H_
|
