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
|
// Copyright 2013 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_ERROR_CONSOLE_ERROR_CONSOLE_H_
#define CHROME_BROWSER_EXTENSIONS_ERROR_CONSOLE_ERROR_CONSOLE_H_
#include "base/memory/scoped_ptr.h"
#include "base/observer_list.h"
#include "base/prefs/pref_change_registrar.h"
#include "base/scoped_observer.h"
#include "base/threading/thread_checker.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "extensions/browser/error_map.h"
#include "extensions/browser/extension_error.h"
#include "extensions/browser/extension_registry_observer.h"
namespace content {
class NotificationDetails;
class NotificationSource;
class RenderViewHost;
}
class Profile;
namespace extensions {
class Extension;
class ExtensionPrefs;
class ExtensionRegistry;
// The ErrorConsole is a central object to which all extension errors are
// reported. This includes errors detected in extensions core, as well as
// runtime Javascript errors. If FeatureSwitch::error_console() is enabled these
// errors can be viewed at chrome://extensions in developer mode.
// This class is owned by ExtensionSystem, making it, in effect, a
// BrowserContext-keyed service.
class ErrorConsole : public content::NotificationObserver,
public ExtensionRegistryObserver {
public:
class Observer {
public:
// Sent when a new error is reported to the error console.
virtual void OnErrorAdded(const ExtensionError* error) = 0;
// Sent upon destruction to allow any observers to invalidate any references
// they have to the error console.
virtual void OnErrorConsoleDestroyed();
};
explicit ErrorConsole(Profile* profile);
~ErrorConsole() override;
// Convenience method to return the ErrorConsole for a given profile.
static ErrorConsole* Get(Profile* profile);
// Set whether or not errors of the specified |type| are stored for the
// extension with the given |extension_id|. This will be stored in the
// preferences.
void SetReportingForExtension(const std::string& extension_id,
ExtensionError::Type type,
bool enabled);
// Set whether or not errors of all types are stored for the extension with
// the given |extension_id|.
void SetReportingAllForExtension(const std::string& extension_id,
bool enabled);
// Returns true if reporting for either manifest or runtime errors is enabled
// for the extension with the given |extension_id|.
bool IsReportingEnabledForExtension(const std::string& extension_id) const;
// Restore default reporting to the given extension.
void UseDefaultReportingForExtension(const std::string& extension_id);
// Report an extension error, and add it to the list.
void ReportError(scoped_ptr<ExtensionError> error);
// Get a collection of weak pointers to all errors relating to the extension
// with the given |extension_id|.
const ErrorList& GetErrorsForExtension(const std::string& extension_id) const;
// Add or remove observers of the ErrorConsole to be notified of any errors
// added.
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Returns whether or not the ErrorConsole is enabled for the
// chrome:extensions page or the Chrome Apps Developer Tools.
//
// TODO(rdevlin.cronin): These have different answers - ErrorConsole is
// enabled by default in ADT, but only Dev Channel for chrome:extensions (or
// with the commandline switch). Once we do a full launch, clean all this up.
bool IsEnabledForChromeExtensionsPage() const;
bool IsEnabledForAppsDeveloperTools() const;
// Return whether or not the ErrorConsole is enabled.
bool enabled() const { return enabled_; }
// Return the number of entries (extensions) in the error map.
size_t get_num_entries_for_test() const { return errors_.size(); }
// Set the default reporting for all extensions.
void set_default_reporting_for_test(ExtensionError::Type type, bool enabled) {
default_mask_ =
enabled ? default_mask_ | (1 << type) : default_mask_ & ~(1 << type);
}
private:
// Checks whether or not the ErrorConsole should be enabled or disabled. If it
// is in the wrong state, enables or disables it appropriately.
void CheckEnabled();
// Enable the error console for error collection and retention. This involves
// subscribing to the appropriate notifications and fetching manifest errors.
void Enable();
// Disable the error console, removing the subscriptions to notifications and
// removing all current errors.
void Disable();
// Called when the Developer Mode preference is changed; this is important
// since we use this as a heuristic to determine if the console is enabled or
// not.
void OnPrefChanged();
// ExtensionRegistry implementation. If the Apps Developer Tools app is
// installed or uninstalled, we may need to turn the ErrorConsole on/off.
void OnExtensionUnloaded(content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionInfo::Reason reason) override;
void OnExtensionLoaded(content::BrowserContext* browser_context,
const Extension* extension) override;
void OnExtensionInstalled(content::BrowserContext* browser_context,
const Extension* extension,
bool is_update) override;
void OnExtensionUninstalled(content::BrowserContext* browser_context,
const Extension* extension,
extensions::UninstallReason reason) override;
// Add manifest errors from an extension's install warnings.
void AddManifestErrorsForExtension(const Extension* extension);
// content::NotificationObserver implementation.
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
// Returns the applicable bit mask of reporting preferences for the extension.
int GetMaskForExtension(const std::string& extension_id) const;
// Whether or not the error console should record errors. This is true if
// the user is in developer mode, and at least one of the following is true:
// - The Chrome Apps Developer Tools are installed.
// - FeatureSwitch::error_console() is enabled.
// - This is a Dev Channel release.
bool enabled_;
// Needed because ObserverList is not thread-safe.
base::ThreadChecker thread_checker_;
// The list of all observers for the ErrorConsole.
ObserverList<Observer> observers_;
// The errors which we have received so far.
ErrorMap errors_;
// The default mask to use if an Extension does not have specific settings.
int32 default_mask_;
// The profile with which the ErrorConsole is associated. Only collect errors
// from extensions and RenderViews associated with this Profile (and it's
// incognito fellow).
Profile* profile_;
// The ExtensionPrefs with which the ErrorConsole is associated. This weak
// pointer is safe because ErrorConsole is owned by ExtensionSystem, which
// is dependent on ExtensionPrefs.
ExtensionPrefs* prefs_;
content::NotificationRegistrar notification_registrar_;
PrefChangeRegistrar pref_registrar_;
ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
registry_observer_;
DISALLOW_COPY_AND_ASSIGN(ErrorConsole);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_ERROR_CONSOLE_ERROR_CONSOLE_H_
|
