blob: eba6ed31c75bdce96e1c15f53da879efabc52c33 [file] [log] [blame]
[email protected]225c8f52010-02-05 22:23:201// Copyright (c) 2010 The Chromium Authors. All rights reserved.
[email protected]7713d632008-12-02 07:52:332// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
[email protected]5b1a0e22009-05-26 19:00:585#ifndef CHROME_COMMON_EXTENSIONS_EXTENSION_H_
6#define CHROME_COMMON_EXTENSIONS_EXTENSION_H_
[email protected]32b76ef2010-07-26 23:08:247#pragma once
[email protected]7713d632008-12-02 07:52:338
[email protected]300cc58db2009-08-19 20:45:149#include <map>
[email protected]facd7a7652009-06-05 23:15:0210#include <set>
[email protected]7713d632008-12-02 07:52:3311#include <string>
12#include <vector>
13
[email protected]6014d672008-12-05 00:38:2514#include "base/file_path.h"
[email protected]19118d52010-07-26 22:13:4215#include "base/gtest_prod_util.h"
[email protected]cc655912009-01-29 23:19:1916#include "base/scoped_ptr.h"
[email protected]4361c7c2010-09-30 21:57:5317#include "base/ref_counted.h"
[email protected]d83a5602010-09-16 00:22:4818#include "chrome/common/extensions/extension_constants.h"
[email protected]867a73e12010-03-19 20:45:4619#include "chrome/common/extensions/extension_extent.h"
[email protected]807871f2010-09-16 01:04:4820#include "chrome/common/extensions/extension_icon_set.h"
[email protected]42b6f0f82009-09-18 21:07:3921#include "chrome/common/extensions/user_script.h"
[email protected]7197f4992009-03-23 05:05:4922#include "chrome/common/extensions/url_pattern.h"
[email protected]052c92702010-06-25 07:25:5223#include "gfx/size.h"
[email protected]eab9b452009-01-23 20:48:5924#include "googleurl/src/gurl.h"
25
[email protected]3bb84992010-08-26 17:23:4626class DictionaryValue;
[email protected]942690b132010-05-11 06:42:1427class ExtensionAction;
28class ExtensionResource;
[email protected]e2dffe02011-01-20 20:30:0629class ExtensionSidebarDefaults;
[email protected]12802702010-07-09 19:43:0930class SkBitmap;
[email protected]daf66aa2010-08-06 06:24:2831class Version;
[email protected]942690b132010-05-11 06:42:1432
[email protected]f0755532010-06-22 07:27:2533// Represents a Chrome extension.
[email protected]66e4eb32010-10-27 20:37:4134class Extension : public base::RefCountedThreadSafe<Extension> {
[email protected]7713d632008-12-02 07:52:3335 public:
[email protected]d3cfa482009-10-17 13:54:5736 typedef std::map<const std::string, GURL> URLOverrideMap;
[email protected]10fb1992010-10-08 09:00:1737 typedef std::vector<std::string> ScriptingWhitelist;
[email protected]b24d8312009-08-27 06:47:4638
[email protected]631cf822009-05-15 07:01:2539 // What an extension was loaded from.
[email protected]9b217652010-10-08 22:04:2340 // NOTE: These values are stored as integers in the preferences and used
41 // in histograms so don't remove or reorder existing items. Just append
42 // to the end.
[email protected]631cf822009-05-15 07:01:2543 enum Location {
44 INVALID,
[email protected]25b34332009-06-05 21:53:1945 INTERNAL, // A crx file from the internal Extensions directory.
46 EXTERNAL_PREF, // A crx file from an external directory (via prefs).
47 EXTERNAL_REGISTRY, // A crx file from an external directory (via eg the
48 // registry on Windows).
[email protected]1952c7d2010-03-04 23:48:3449 LOAD, // --load-extension.
[email protected]8ef78fd2010-08-19 17:14:3250 COMPONENT, // An integral component of Chrome itself, which
51 // happens to be implemented as an extension. We don't
52 // show these in the management UI.
[email protected]4d2913e32010-11-30 00:28:5553 EXTERNAL_PREF_DOWNLOAD, // A crx file from an external directory (via
54 // prefs), installed from an update URL.
55 EXTERNAL_POLICY_DOWNLOAD, // A crx file from an external directory (via
56 // admin policies), installed from an update URL.
[email protected]04cb7542010-10-25 10:50:0657
58 NUM_LOCATIONS
[email protected]25b34332009-06-05 21:53:1959 };
60
61 enum State {
[email protected]0c6da502009-08-14 22:32:3962 DISABLED = 0,
[email protected]25b34332009-06-05 21:53:1963 ENABLED,
64 KILLBIT, // Don't install/upgrade (applies to external extensions only).
[email protected]0c6da502009-08-14 22:32:3965
66 NUM_STATES
[email protected]631cf822009-05-15 07:01:2567 };
[email protected]7713d632008-12-02 07:52:3368
[email protected]fbcc40302009-06-12 20:45:4569 enum InstallType {
[email protected]ab6f2b22009-07-28 23:28:3770 INSTALL_ERROR,
[email protected]fbcc40302009-06-12 20:45:4571 DOWNGRADE,
72 REINSTALL,
73 UPGRADE,
74 NEW_INSTALL
75 };
76
[email protected]d2817012009-08-04 06:46:2177 // NOTE: If you change this list, you should also change kIconSizes in the cc
78 // file.
79 enum Icons {
80 EXTENSION_ICON_LARGE = 128,
81 EXTENSION_ICON_MEDIUM = 48,
82 EXTENSION_ICON_SMALL = 32,
[email protected]39382942010-03-23 15:57:0983 EXTENSION_ICON_SMALLISH = 24,
[email protected]d2817012009-08-04 06:46:2184 EXTENSION_ICON_BITTY = 16,
85 };
86
[email protected]7fa19f82010-12-21 19:40:0887 // Do not change the order of entries or remove entries in this list
88 // as this is used in UMA_HISTOGRAM_ENUMERATIONs about extensions.
89 enum Type {
[email protected]9b217652010-10-08 22:04:2390 TYPE_UNKNOWN = 0,
91 TYPE_EXTENSION,
92 TYPE_THEME,
93 TYPE_USER_SCRIPT,
94 TYPE_HOSTED_APP,
95 TYPE_PACKAGED_APP
96 };
97
[email protected]92888082010-10-18 19:24:5798 // An NPAPI plugin included in the extension.
99 struct PluginInfo {
100 FilePath path; // Path to the plugin.
101 bool is_public; // False if only this extension can load this plugin.
102 };
103
[email protected]a4a38c12010-12-23 16:43:56104 struct TtsVoice {
105 std::string voice_name;
106 std::string locale;
107 std::string gender;
108 };
109
[email protected]0df165f2010-09-28 16:49:40110 // A permission is defined by its |name| (what is used in the manifest),
111 // and the |message_id| that's used by install/update UI.
112 struct Permission {
113 const char* const name;
114 const int message_id;
115 };
116
[email protected]66e4eb32010-10-27 20:37:41117 static scoped_refptr<Extension> Create(const FilePath& path,
118 Location location,
119 const DictionaryValue& value,
120 bool require_key,
121 std::string* error);
122
[email protected]4d2913e32010-11-30 00:28:55123 // Return the update url used by gallery/webstore extensions.
124 static GURL GalleryUpdateUrl(bool secure);
125
[email protected]0df165f2010-09-28 16:49:40126 // The install message id for |permission|. Returns 0 if none exists.
127 static int GetPermissionMessageId(const std::string& permission);
128
[email protected]a2a098d2010-09-29 19:42:55129 // Returns the full list of permission messages that this extension
130 // should display at install time.
[email protected]9adb9692010-10-29 23:14:02131 std::vector<string16> GetPermissionMessages() const;
[email protected]a2a098d2010-09-29 19:42:55132
[email protected]d6a5c78c2010-12-07 05:18:15133 // Returns the distinct hosts that should be displayed in the install UI
134 // for the URL patterns |list|. This discards some of the detail that is
135 // present in the manifest to make it as easy as possible to process by
136 // users. In particular we disregard the scheme and path components of
137 // URLPatterns and de-dupe the result, which includes filtering out common
138 // hosts with differing RCDs. (NOTE: when de-duping hosts with common RCDs,
139 // the first pattern is returned and the rest discarded)
140 static std::vector<std::string> GetDistinctHostsForDisplay(
141 const URLPatternList& list);
142
143 // Compares two URLPatternLists for security equality by returning whether
144 // the URL patterns in |new_list| contain additional distinct hosts compared
145 // to |old_list|.
146 static bool IsElevatedHostList(
147 const URLPatternList& old_list, const URLPatternList& new_list);
[email protected]0df165f2010-09-28 16:49:40148
[email protected]c3e3def742009-07-17 07:51:06149 // Icon sizes used by the extension system.
[email protected]d2817012009-08-04 06:46:21150 static const int kIconSizes[];
[email protected]c3e3def742009-07-17 07:51:06151
[email protected]4c4f8192009-10-17 01:03:26152 // Max size (both dimensions) for browser and page actions.
153 static const int kPageActionIconMaxSize;
154 static const int kBrowserActionIconMaxSize;
[email protected]e2dffe02011-01-20 20:30:06155 static const int kSidebarIconMaxSize;
[email protected]4c4f8192009-10-17 01:03:26156
[email protected]35506352009-08-07 18:58:19157 // Each permission is a module that the extension is permitted to use.
[email protected]218990c2010-06-26 01:21:07158 //
[email protected]0df165f2010-09-28 16:49:40159 // NOTE: To add a new permission, define it here, and add an entry to
160 // Extension::kPermissions.
[email protected]9dcf8f12010-09-02 20:39:19161 static const char kBackgroundPermission[];
162 static const char kBookmarkPermission[];
163 static const char kContextMenusPermission[];
164 static const char kCookiePermission[];
165 static const char kExperimentalPermission[];
166 static const char kGeolocationPermission[];
167 static const char kHistoryPermission[];
168 static const char kIdlePermission[];
[email protected]eb255772010-10-04 22:10:46169 static const char kManagementPermission[];
[email protected]9dcf8f12010-09-02 20:39:19170 static const char kNotificationPermission[];
171 static const char kProxyPermission[];
172 static const char kTabPermission[];
173 static const char kUnlimitedStoragePermission[];
[email protected]9dcf8f12010-09-02 20:39:19174 static const char kWebstorePrivatePermission[];
[email protected]aeb53b32009-10-29 07:34:45175
[email protected]0df165f2010-09-28 16:49:40176 static const Permission kPermissions[];
[email protected]35506352009-08-07 18:58:19177 static const size_t kNumPermissions;
[email protected]9dcf8f12010-09-02 20:39:19178 static const char* const kHostedAppPermissionNames[];
[email protected]b746f372010-08-29 21:39:32179 static const size_t kNumHostedAppPermissions;
[email protected]35506352009-08-07 18:58:19180
[email protected]03b612f2010-08-13 21:09:21181 // The old name for the unlimited storage permission, which is deprecated but
182 // still accepted as meaning the same thing as kUnlimitedStoragePermission.
[email protected]9dcf8f12010-09-02 20:39:19183 static const char kOldUnlimitedStoragePermission[];
[email protected]03b612f2010-08-13 21:09:21184
[email protected]8d888c12010-11-30 00:00:25185 // Valid schemes for web extent URLPatterns.
186 static const int kValidWebExtentSchemes;
187
[email protected]f71f7e62010-12-07 03:45:33188 // Valid schemes for host permission URLPatterns.
189 static const int kValidHostPermissionSchemes;
190
[email protected]b746f372010-08-29 21:39:32191 // Returns true if the string is one of the known hosted app permissions (see
192 // kHostedAppPermissionNames).
193 static bool IsHostedAppPermission(const std::string& permission);
194
[email protected]6014d672008-12-05 00:38:25195 // The name of the manifest inside an extension.
[email protected]99efb7b12009-12-18 02:39:16196 static const FilePath::CharType kManifestFilename[];
[email protected]6014d672008-12-05 00:38:25197
[email protected]300cc58db2009-08-19 20:45:14198 // The name of locale folder inside an extension.
[email protected]99efb7b12009-12-18 02:39:16199 static const FilePath::CharType kLocaleFolder[];
[email protected]300cc58db2009-08-19 20:45:14200
201 // The name of the messages file inside an extension.
[email protected]99efb7b12009-12-18 02:39:16202 static const FilePath::CharType kMessagesFilename[];
[email protected]300cc58db2009-08-19 20:45:14203
[email protected]25b34332009-06-05 21:53:19204#if defined(OS_WIN)
[email protected]9dcf8f12010-09-02 20:39:19205 static const char kExtensionRegistryPath[];
[email protected]25b34332009-06-05 21:53:19206#endif
207
[email protected]37eeb5a2009-02-26 23:36:17208 // The number of bytes in a legal id.
[email protected]fe0e7822009-02-26 23:51:48209 static const size_t kIdSize;
[email protected]37eeb5a2009-02-26 23:36:17210
[email protected]e435d6b72009-07-25 03:15:58211 // The mimetype used for extensions.
212 static const char kMimeType[];
213
[email protected]25b34332009-06-05 21:53:19214 // Checks to see if the extension has a valid ID.
215 static bool IdIsValid(const std::string& id);
216
[email protected]4ead6f72010-10-13 19:54:18217 // Generate an ID for an extension in the given path.
218 static std::string GenerateIdForPath(const FilePath& file_name);
219
[email protected]e435d6b72009-07-25 03:15:58220 // Returns true if the specified file is an extension.
221 static bool IsExtension(const FilePath& file_name);
222
[email protected]25b34332009-06-05 21:53:19223 // Whether the |location| is external or not.
224 static inline bool IsExternalLocation(Location location) {
225 return location == Extension::EXTERNAL_PREF ||
[email protected]8ef78fd2010-08-19 17:14:32226 location == Extension::EXTERNAL_REGISTRY ||
[email protected]04cb7542010-10-25 10:50:06227 location == Extension::EXTERNAL_PREF_DOWNLOAD ||
228 location == Extension::EXTERNAL_POLICY_DOWNLOAD;
229 }
230
231 // Whether extensions with |location| are auto-updatable or not.
232 static inline bool IsAutoUpdateableLocation(Location location) {
233 // Only internal and external extensions can be autoupdated.
234 return location == Extension::INTERNAL ||
235 IsExternalLocation(location);
[email protected]25b34332009-06-05 21:53:19236 }
237
[email protected]7fa19f82010-12-21 19:40:08238 // See Type definition above.
239 Type GetType() const;
[email protected]9b217652010-10-08 22:04:23240
[email protected]07c00d992009-03-04 20:27:04241 // Returns an absolute url to a resource inside of an extension. The
[email protected]eab9b452009-01-23 20:48:59242 // |extension_url| argument should be the url() from an Extension object. The
243 // |relative_path| can be untrusted user input. The returned URL will either
244 // be invalid() or a child of |extension_url|.
245 // NOTE: Static so that it can be used from multiple threads.
246 static GURL GetResourceURL(const GURL& extension_url,
247 const std::string& relative_path);
[email protected]cffd7892010-08-26 17:43:28248 GURL GetResourceURL(const std::string& relative_path) const {
[email protected]3cfbd0e2009-03-18 21:26:24249 return GetResourceURL(url(), relative_path);
250 }
[email protected]eab9b452009-01-23 20:48:59251
[email protected]99efb7b12009-12-18 02:39:16252 // Returns an extension resource object. |relative_path| should be UTF8
253 // encoded.
[email protected]9adb9692010-10-29 23:14:02254 ExtensionResource GetResource(const std::string& relative_path) const;
[email protected]99efb7b12009-12-18 02:39:16255
256 // As above, but with |relative_path| following the file system's encoding.
[email protected]9adb9692010-10-29 23:14:02257 ExtensionResource GetResource(const FilePath& relative_path) const;
[email protected]eab9b452009-01-23 20:48:59258
[email protected]a17f9462009-06-09 02:56:41259 // |input| is expected to be the text of an rsa public or private key. It
260 // tolerates the presence or absence of bracking header/footer like this:
261 // -----(BEGIN|END) [RSA PUBLIC/PRIVATE] KEY-----
262 // and may contain newlines.
263 static bool ParsePEMKeyBytes(const std::string& input, std::string* output);
264
265 // Does a simple base64 encoding of |input| into |output|.
266 static bool ProducePEM(const std::string& input, std::string* output);
267
[email protected]84ac7f32009-10-06 06:17:54268 // Generates an extension ID from arbitrary input. The same input string will
269 // always generate the same output ID.
270 static bool GenerateId(const std::string& input, std::string* output);
[email protected]fbcc40302009-06-12 20:45:45271
[email protected]a17f9462009-06-09 02:56:41272 // Expects base64 encoded |input| and formats into |output| including
273 // the appropriate header & footer.
274 static bool FormatPEMForFileOutput(const std::string input,
275 std::string* output, bool is_public);
276
[email protected]2a409532009-08-28 19:39:44277 // Determine whether |new_extension| has increased privileges compared to
[email protected]8d888c12010-11-30 00:00:25278 // its previously granted permissions, specified by |granted_apis|,
279 // |granted_extent| and |granted_full_access|.
280 static bool IsPrivilegeIncrease(const bool granted_full_access,
281 const std::set<std::string>& granted_apis,
282 const ExtensionExtent& granted_extent,
[email protected]9adb9692010-10-29 23:14:02283 const Extension* new_extension);
[email protected]b24d8312009-08-27 06:47:46284
[email protected]c690a9812009-12-17 05:55:32285 // Given an extension and icon size, read it if present and decode it into
[email protected]ae2e0f92010-04-06 20:32:23286 // result. In the browser process, this will DCHECK if not called on the
287 // file thread. To easily load extension images on the UI thread, see
288 // ImageLoadingTracker.
[email protected]9adb9692010-10-29 23:14:02289 static void DecodeIcon(const Extension* extension,
[email protected]c690a9812009-12-17 05:55:32290 Icons icon_size,
291 scoped_ptr<SkBitmap>* result);
292
293 // Given an icon_path and icon size, read it if present and decode it into
[email protected]ae2e0f92010-04-06 20:32:23294 // result. In the browser process, this will DCHECK if not called on the
295 // file thread. To easily load extension images on the UI thread, see
296 // ImageLoadingTracker.
[email protected]c690a9812009-12-17 05:55:32297 static void DecodeIconFromPath(const FilePath& icon_path,
298 Icons icon_size,
299 scoped_ptr<SkBitmap>* result);
300
[email protected]a807bbe2010-04-14 10:51:19301 // Returns the base extension url for a given |extension_id|.
302 static GURL GetBaseURLFromExtensionId(const std::string& extension_id);
303
[email protected]ec5b50d2010-10-09 16:35:18304 // Returns the url prefix for the extension/apps gallery. Can be set via the
[email protected]ce3eb7b62010-09-14 13:57:44305 // --apps-gallery-url switch. The URL returned will not contain a trailing
[email protected]d3071992010-10-08 15:24:07306 // slash. Do not use this as a prefix/extent for the store. Instead see
[email protected]eaa7dd182010-12-14 11:09:00307 // ExtensionService::GetWebStoreApp or
308 // ExtensionService::IsDownloadFromGallery
[email protected]d3071992010-10-08 15:24:07309 static std::string ChromeStoreLaunchURL();
[email protected]a0cf04a2010-06-23 03:29:55310
[email protected]be7e5cb2010-10-04 12:53:17311 // Adds an extension to the scripting whitelist. Used for testing only.
[email protected]10fb1992010-10-08 09:00:17312 static void SetScriptingWhitelist(const ScriptingWhitelist& whitelist);
[email protected]2a521c52011-01-26 18:45:21313 static const ScriptingWhitelist* GetScriptingWhitelist();
[email protected]be7e5cb2010-10-04 12:53:17314
[email protected]aeb53b32009-10-29 07:34:45315 // Returns true if the extension has the specified API permission.
[email protected]0df165f2010-09-28 16:49:40316 static bool HasApiPermission(const std::set<std::string>& api_permissions,
[email protected]246c05f2010-09-10 09:12:11317 const std::string& function_name);
[email protected]583d45c12010-08-31 02:48:12318
[email protected]8d888c12010-11-30 00:00:25319 // Whether the |effective_host_permissions| and |api_permissions| include
320 // effective access to all hosts. See the non-static version of the method
321 // for more details.
322 static bool HasEffectiveAccessToAllHosts(
323 const ExtensionExtent& effective_host_permissions,
324 const std::set<std::string>& api_permissions);
325
[email protected]246c05f2010-09-10 09:12:11326 bool HasApiPermission(const std::string& function_name) const {
327 return HasApiPermission(this->api_permissions(), function_name);
[email protected]aeb53b32009-10-29 07:34:45328 }
329
[email protected]4361c7c2010-09-30 21:57:53330 const ExtensionExtent& GetEffectiveHostPermissions() const {
[email protected]6f229e82010-11-02 17:47:26331 return effective_host_permissions_;
[email protected]4361c7c2010-09-30 21:57:53332 }
[email protected]b24d8312009-08-27 06:47:46333
[email protected]fbd17cf2010-04-28 23:52:56334 // Whether or not the extension is allowed permission for a URL pattern from
335 // the manifest. http, https, and chrome://favicon/ is allowed for all
336 // extensions, while component extensions are allowed access to
337 // chrome://resources.
[email protected]a3caa822010-10-26 18:10:00338 bool CanSpecifyHostPermission(const URLPattern& pattern) const;
[email protected]fbd17cf2010-04-28 23:52:56339
[email protected]584b8e3f2010-04-10 00:23:37340 // Whether the extension has access to the given URL.
341 bool HasHostPermission(const GURL& url) const;
342
[email protected]0df165f2010-09-28 16:49:40343 // Whether the extension has effective access to all hosts. This is true if
344 // there is a content script that matches all hosts, if there is a host
345 // permission grants access to all hosts (like <all_urls>) or an api
346 // permission that effectively grants access to all hosts (e.g. proxy,
347 // network, etc.)
348 bool HasEffectiveAccessToAllHosts() const;
[email protected]b24d8312009-08-27 06:47:46349
[email protected]8d888c12010-11-30 00:00:25350 // Whether the extension effectively has all permissions (for example, by
351 // having an NPAPI plugin).
352 bool HasFullPermissions() const;
353
[email protected]5df6a5d2011-01-26 07:39:12354 // Whether context menu should be shown for page and browser actions.
355 bool ShowConfigureContextMenus() const;
356
[email protected]37cd64d2010-10-25 18:17:58357 // Returns the Homepage URL for this extension. If homepage_url was not
358 // specified in the manifest, this returns the Google Gallery URL. For
[email protected]bfa90a3a2010-04-28 15:43:23359 // third-party extensions, this returns a blank GURL.
[email protected]37cd64d2010-10-25 18:17:58360 GURL GetHomepageURL() const;
[email protected]bfa90a3a2010-04-28 15:43:23361
[email protected]facd7a7652009-06-05 23:15:02362 // Returns a list of paths (relative to the extension dir) for images that
363 // the browser might load (like themes and page action icons).
[email protected]9adb9692010-10-29 23:14:02364 std::set<FilePath> GetBrowserImages() const;
[email protected]facd7a7652009-06-05 23:15:02365
[email protected]807871f2010-09-16 01:04:48366 // Get an extension icon as a resource or URL.
[email protected]9adb9692010-10-29 23:14:02367 ExtensionResource GetIconResource(
368 int size, ExtensionIconSet::MatchType match_type) const;
369 GURL GetIconURL(int size, ExtensionIconSet::MatchType match_type) const;
[email protected]f34e79632010-03-17 02:34:08370
[email protected]867a73e12010-03-19 20:45:46371 // Gets the fully resolved absolute launch URL.
372 GURL GetFullLaunchURL() const;
[email protected]2a521c52011-01-26 18:45:21373
[email protected]6f229e82010-11-02 17:47:26374 // Image cache related methods. These are only valid on the UI thread and
375 // not maintained by this class. See ImageLoadingTracker for usage. The
376 // |original_size| parameter should be the size of the image at |source|
377 // before any scaling may have been done to produce the pixels in |image|.
378 void SetCachedImage(const ExtensionResource& source,
379 const SkBitmap& image,
380 const gfx::Size& original_size) const;
381 bool HasCachedImage(const ExtensionResource& source,
382 const gfx::Size& max_size) const;
383 SkBitmap GetCachedImage(const ExtensionResource& source,
384 const gfx::Size& max_size) const;
[email protected]2a521c52011-01-26 18:45:21385
386 // Returns true if this extension can execute script on a page. If a
387 // UserScript object is passed, permission to run that specific script is
388 // checked (using its matches list). Otherwise, permission to execute script
389 // programmatically is checked (using the extension's host permission).
390 //
391 // This method is also aware of certain special pages that extensions are
392 // usually not allowed to run script on.
393 bool CanExecuteScriptOnPage(const GURL& page_url,
394 UserScript* script,
395 std::string* error) const;
396
[email protected]6f229e82010-11-02 17:47:26397 // Returns true if this extension is a COMPONENT extension, or if it is
398 // on the whitelist of extensions that can script all pages.
399 bool CanExecuteScriptEverywhere() const;
400
[email protected]a65882c2010-11-12 15:15:09401 // Returns true if this extension updates itself using the extension
402 // gallery.
403 bool UpdatesFromGallery() const;
404
[email protected]6f229e82010-11-02 17:47:26405 // Accessors:
406
407 const FilePath& path() const { return path_; }
408 const GURL& url() const { return extension_url_; }
409 Location location() const { return location_; }
410 const std::string& id() const { return id_; }
411 const Version* version() const { return version_.get(); }
412 const std::string VersionString() const;
413 const std::string& name() const { return name_; }
414 const std::string& public_key() const { return public_key_; }
415 const std::string& description() const { return description_; }
416 bool converted_from_user_script() const {
417 return converted_from_user_script_;
418 }
419 const UserScriptList& content_scripts() const { return content_scripts_; }
420 ExtensionAction* page_action() const { return page_action_.get(); }
421 ExtensionAction* browser_action() const { return browser_action_.get(); }
[email protected]e2dffe02011-01-20 20:30:06422 ExtensionSidebarDefaults* sidebar_defaults() const {
423 return sidebar_defaults_.get();
424 }
[email protected]6f229e82010-11-02 17:47:26425 const std::vector<PluginInfo>& plugins() const { return plugins_; }
426 const GURL& background_url() const { return background_url_; }
427 const GURL& options_url() const { return options_url_; }
428 const GURL& devtools_url() const { return devtools_url_; }
429 const std::vector<GURL>& toolstrips() const { return toolstrips_; }
430 const std::set<std::string>& api_permissions() const {
431 return api_permissions_;
432 }
433 const URLPatternList& host_permissions() const { return host_permissions_; }
434 const GURL& update_url() const { return update_url_; }
435 const ExtensionIconSet& icons() const { return icons_; }
436 const DictionaryValue* manifest_value() const {
437 return manifest_value_.get();
438 }
439 const std::string default_locale() const { return default_locale_; }
440 const URLOverrideMap& GetChromeURLOverrides() const {
441 return chrome_url_overrides_;
442 }
443 const std::string omnibox_keyword() const { return omnibox_keyword_; }
444 bool incognito_split_mode() const { return incognito_split_mode_; }
[email protected]a4a38c12010-12-23 16:43:56445 const std::vector<TtsVoice>& tts_voices() const { return tts_voices_; }
[email protected]6f229e82010-11-02 17:47:26446
447 // App-related.
448 bool is_app() const { return is_app_; }
449 bool is_hosted_app() const { return is_app() && !web_extent().is_empty(); }
450 bool is_packaged_app() const { return is_app() && web_extent().is_empty(); }
451 const ExtensionExtent& web_extent() const { return extent_; }
452 const std::string& launch_local_path() const { return launch_local_path_; }
453 const std::string& launch_web_url() const { return launch_web_url_; }
454 extension_misc::LaunchContainer launch_container() const {
455 return launch_container_;
456 }
457 int launch_width() const { return launch_width_; }
458 int launch_height() const { return launch_height_; }
459
460 // Theme-related.
461 bool is_theme() const { return is_theme_; }
462 DictionaryValue* GetThemeImages() const { return theme_images_.get(); }
463 DictionaryValue* GetThemeColors() const {return theme_colors_.get(); }
464 DictionaryValue* GetThemeTints() const { return theme_tints_.get(); }
465 DictionaryValue* GetThemeDisplayProperties() const {
466 return theme_display_properties_.get();
467 }
468
[email protected]4a8d3272009-03-10 19:15:08469 private:
[email protected]66e4eb32010-10-27 20:37:41470 friend class base::RefCountedThreadSafe<Extension>;
471
[email protected]d7e9a862010-11-03 21:57:49472 // We keep a cache of images loaded from extension resources based on their
473 // path and a string representation of a size that may have been used to
474 // scale it (or the empty string if the image is at its original size).
475 typedef std::pair<FilePath, std::string> ImageCacheKey;
476 typedef std::map<ImageCacheKey, SkBitmap> ImageCache;
477
[email protected]4ead6f72010-10-13 19:54:18478 // Normalize the path for use by the extension. On Windows, this will make
479 // sure the drive letter is uppercase.
480 static FilePath MaybeNormalizePath(const FilePath& path);
481
[email protected]d6a5c78c2010-12-07 05:18:15482 // Returns the distinct hosts that can be displayed in the install UI or be
483 // used for privilege comparisons. This discards some of the detail that is
484 // present in the manifest to make it as easy as possible to process by users.
485 // In particular we disregard the scheme and path components of URLPatterns
486 // and de-dupe the result, which includes filtering out common hosts with
487 // differing RCDs. If |include_rcd| is true, then the de-duped result
488 // will be the first full entry, including its RCD. So if the list was
489 // "*.google.co.uk" and "*.google.com", the returned value would just be
490 // "*.google.co.uk". Keeping the RCD in the result is useful for display
491 // purposes when you want to show the user one sample hostname from the list.
492 // If you need to compare two URLPatternLists for security equality, then set
493 // |include_rcd| to false, which will return a result like "*.google.",
494 // regardless of the order of the patterns.
495 static std::vector<std::string> GetDistinctHosts(
496 const URLPatternList& host_patterns, bool include_rcd);
497
[email protected]66e4eb32010-10-27 20:37:41498 Extension(const FilePath& path, Location location);
499 ~Extension();
500
501 // Initialize the extension from a parsed manifest.
502 // Usually, the id of an extension is generated by the "key" property of
503 // its manifest, but if |require_key| is |false|, a temporary ID will be
504 // generated based on the path.
505 bool InitFromValue(const DictionaryValue& value, bool require_key,
506 std::string* error);
507
[email protected]052c92702010-06-25 07:25:52508 // Helper function for implementing HasCachedImage/GetCachedImage. A return
509 // value of NULL means there is no matching image cached (we allow caching an
510 // empty SkBitmap).
511 SkBitmap* GetCachedImageImpl(const ExtensionResource& source,
[email protected]9adb9692010-10-29 23:14:02512 const gfx::Size& max_size) const;
[email protected]d9ad80f2010-03-30 20:40:18513
[email protected]3cfbd0e2009-03-18 21:26:24514 // Helper method that loads a UserScript object from a
515 // dictionary in the content_script list of the manifest.
516 bool LoadUserScriptHelper(const DictionaryValue* content_script,
517 int definition_index,
518 std::string* error,
519 UserScript* result);
[email protected]f7f3a5f2009-05-01 22:02:34520
[email protected]6657afa62009-11-04 02:15:20521 // Helper method that loads either the include_globs or exclude_globs list
522 // from an entry in the content_script lists of the manifest.
523 bool LoadGlobsHelper(const DictionaryValue* content_script,
524 int content_script_index,
[email protected]e2194742010-08-12 05:54:34525 const char* globs_property_name,
[email protected]6657afa62009-11-04 02:15:20526 std::string* error,
[email protected]11f4857282009-11-13 19:56:17527 void(UserScript::*add_method)(const std::string& glob),
[email protected]6657afa62009-11-04 02:15:20528 UserScript *instance);
529
[email protected]867a73e12010-03-19 20:45:46530 // Helpers to load various chunks of the manifest.
[email protected]3ba0fd32010-06-19 05:39:10531 bool LoadIsApp(const DictionaryValue* manifest, std::string* error);
[email protected]e2194742010-08-12 05:54:34532 bool LoadExtent(const DictionaryValue* manifest, const char* key,
[email protected]4fdbc1492010-07-01 01:20:59533 ExtensionExtent* extent, const char* list_error,
534 const char* value_error, std::string* error);
[email protected]867a73e12010-03-19 20:45:46535 bool LoadLaunchContainer(const DictionaryValue* manifest, std::string* error);
536 bool LoadLaunchURL(const DictionaryValue* manifest, std::string* error);
[email protected]cbf4d1912010-08-12 18:24:57537 bool EnsureNotHybridApp(const DictionaryValue* manifest, std::string* error);
[email protected]867a73e12010-03-19 20:45:46538
[email protected]5d246db22009-10-27 06:17:57539 // Helper method to load an ExtensionAction from the page_action or
[email protected]92c6f9b92009-10-24 04:35:08540 // browser_action entries in the manifest.
[email protected]5d246db22009-10-27 06:17:57541 ExtensionAction* LoadExtensionActionHelper(
[email protected]92c6f9b92009-10-24 04:35:08542 const DictionaryValue* extension_action, std::string* error);
543
[email protected]e2dffe02011-01-20 20:30:06544 // Helper method to load an ExtensionSidebarDefaults from the sidebar manifest
545 // entry.
546 ExtensionSidebarDefaults* LoadExtensionSidebarDefaults(
547 const DictionaryValue* sidebar, std::string* error);
548
[email protected]4361c7c2010-09-30 21:57:53549 // Calculates the effective host permissions from the permissions and content
550 // script petterns.
551 void InitEffectiveHostPermissions();
552
[email protected]2f6698b2010-10-14 00:58:21553 // Returns true if the extension has more than one "UI surface". For example,
554 // an extension that has a browser action and a page action.
555 bool HasMultipleUISurfaces() const;
556
[email protected]e2eb43112009-05-29 21:19:54557 // Figures out if a source contains keys not associated with themes - we
558 // don't want to allow scripts and such to be bundled with themes.
[email protected]9adb9692010-10-29 23:14:02559 bool ContainsNonThemeKeys(const DictionaryValue& source) const;
[email protected]e2eb43112009-05-29 21:19:54560
[email protected]1952c7d2010-03-04 23:48:34561 // Returns true if the string is one of the known api permissions (see
[email protected]0df165f2010-09-28 16:49:40562 // kPermissions).
[email protected]9adb9692010-10-29 23:14:02563 bool IsAPIPermission(const std::string& permission) const;
[email protected]1952c7d2010-03-04 23:48:34564
[email protected]a2a098d2010-09-29 19:42:55565 // The set of unique API install messages that the extension has.
566 // NOTE: This only includes messages related to permissions declared in the
567 // "permissions" key in the manifest. Permissions implied from other features
568 // of the manifest, like plugins and content scripts are not included.
[email protected]9adb9692010-10-29 23:14:02569 std::set<string16> GetSimplePermissionMessages() const;
[email protected]a2a098d2010-09-29 19:42:55570
571 // The permission message displayed related to the host permissions for
572 // this extension.
[email protected]9adb9692010-10-29 23:14:02573 string16 GetHostPermissionMessage() const;
[email protected]a2a098d2010-09-29 19:42:55574
[email protected]d7e9a862010-11-03 21:57:49575 // Cached images for this extension. This should only be touched on the UI
576 // thread.
577 mutable ImageCache image_cache_;
[email protected]1e8c93f2010-02-08 22:58:31578
[email protected]6f229e82010-11-02 17:47:26579 // A persistent, globally unique ID. An extension's ID is used in things
580 // like directory structures and URLs, and is expected to not change across
581 // versions. It is generated as a SHA-256 hash of the extension's public
582 // key, or as a hash of the path in the case of unpacked extensions.
583 std::string id_;
584
585 // The extension's human-readable name. Name is used for display purpose. It
586 // might be wrapped with unicode bidi control characters so that it is
587 // displayed correctly in RTL context.
588 // NOTE: Name is UTF-8 and may contain non-ascii characters.
589 std::string name_;
590
591 // The absolute path to the directory the extension is stored in.
592 FilePath path_;
593
594 // Default locale for fall back. Can be empty if extension is not localized.
595 std::string default_locale_;
596
597 // If true, a separate process will be used for the extension in incognito
598 // mode.
599 bool incognito_split_mode_;
600
601 // Defines the set of URLs in the extension's web content.
602 ExtensionExtent extent_;
603
604 // The set of host permissions that the extension effectively has access to,
605 // which is a merge of host_permissions_ and all of the match patterns in
606 // any content scripts the extension has. This is used to determine which
607 // URLs have the ability to load an extension's resources via embedded
608 // chrome-extension: URLs (see extension_protocols.cc).
609 ExtensionExtent effective_host_permissions_;
610
611 // The set of module-level APIs this extension can use.
612 std::set<std::string> api_permissions_;
613
614 // The icons for the extension.
615 ExtensionIconSet icons_;
616
617 // The base extension url for the extension.
618 GURL extension_url_;
619
620 // The location the extension was loaded from.
621 Location location_;
622
623 // The extension's version.
624 scoped_ptr<Version> version_;
625
626 // An optional longer description of the extension.
627 std::string description_;
628
629 // True if the extension was generated from a user script. (We show slightly
630 // different UI if so).
631 bool converted_from_user_script_;
632
633 // Paths to the content scripts the extension contains.
634 UserScriptList content_scripts_;
635
636 // The extension's page action, if any.
637 scoped_ptr<ExtensionAction> page_action_;
638
639 // The extension's browser action, if any.
640 scoped_ptr<ExtensionAction> browser_action_;
641
[email protected]e2dffe02011-01-20 20:30:06642 // The extension's sidebar, if any.
643 scoped_ptr<ExtensionSidebarDefaults> sidebar_defaults_;
644
[email protected]6f229e82010-11-02 17:47:26645 // Optional list of NPAPI plugins and associated properties.
646 std::vector<PluginInfo> plugins_;
647
648 // Optional URL to a master page of which a single instance should be always
649 // loaded in the background.
650 GURL background_url_;
651
652 // Optional URL to a page for setting options/preferences.
653 GURL options_url_;
654
655 // Optional URL to a devtools extension page.
656 GURL devtools_url_;
657
658 // Optional list of toolstrips and associated properties.
659 std::vector<GURL> toolstrips_;
660
661 // The public key used to sign the contents of the crx package.
662 std::string public_key_;
663
664 // A map of resource id's to relative file paths.
665 scoped_ptr<DictionaryValue> theme_images_;
666
667 // A map of color names to colors.
668 scoped_ptr<DictionaryValue> theme_colors_;
669
670 // A map of color names to colors.
671 scoped_ptr<DictionaryValue> theme_tints_;
672
673 // A map of display properties.
674 scoped_ptr<DictionaryValue> theme_display_properties_;
675
676 // Whether the extension is a theme.
677 bool is_theme_;
678
679 // The sites this extension has permission to talk to (using XHR, etc).
680 URLPatternList host_permissions_;
681
682 // The homepage for this extension. Useful if it is not hosted by Google and
683 // therefore does not have a Gallery URL.
684 GURL homepage_url_;
685
686 // URL for fetching an update manifest
687 GURL update_url_;
688
689 // A copy of the manifest that this extension was created from.
690 scoped_ptr<DictionaryValue> manifest_value_;
691
692 // A map of chrome:// hostnames (newtab, downloads, etc.) to Extension URLs
693 // which override the handling of those URLs. (see ExtensionOverrideUI).
694 URLOverrideMap chrome_url_overrides_;
695
696 // Whether this extension uses app features.
697 bool is_app_;
698
699 // The local path inside the extension to use with the launcher.
700 std::string launch_local_path_;
701
702 // A web url to use with the launcher. Note that this might be relative or
703 // absolute. If relative, it is relative to web_origin.
704 std::string launch_web_url_;
705
706 // The type of container to launch into.
707 extension_misc::LaunchContainer launch_container_;
708
709 // The default size of the container when launching. Only respected for
710 // containers like panels and windows.
711 int launch_width_;
712 int launch_height_;
713
714 // The Omnibox keyword for this extension, or empty if there is none.
715 std::string omnibox_keyword_;
716
[email protected]a4a38c12010-12-23 16:43:56717 // List of text-to-speech voices that this extension provides, if any.
718 std::vector<TtsVoice> tts_voices_;
719
[email protected]eaa7dd182010-12-14 11:09:00720 FRIEND_TEST_ALL_PREFIXES(ExtensionServiceTest,
[email protected]5eb375e92010-11-26 07:50:41721 UpdateExtensionPreservesLocation);
[email protected]19118d52010-07-26 22:13:42722 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, LoadPageActionHelper);
[email protected]66e4eb32010-10-27 20:37:41723 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueInvalid);
724 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueValid);
725 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueValidNameInRTL);
[email protected]19118d52010-07-26 22:13:42726 FRIEND_TEST_ALL_PREFIXES(TabStripModelTest, Apps);
[email protected]ae7fe712009-07-02 20:33:58727
[email protected]894bb502009-05-21 22:39:57728 DISALLOW_COPY_AND_ASSIGN(Extension);
[email protected]7713d632008-12-02 07:52:33729};
730
[email protected]9adb9692010-10-29 23:14:02731typedef std::vector< scoped_refptr<const Extension> > ExtensionList;
[email protected]ec5b50d2010-10-09 16:35:18732typedef std::set<std::string> ExtensionIdSet;
[email protected]b1748b1d82009-11-30 20:32:56733
[email protected]c6d474f82009-12-16 21:11:06734// Handy struct to pass core extension info around.
735struct ExtensionInfo {
736 ExtensionInfo(const DictionaryValue* manifest,
737 const std::string& id,
738 const FilePath& path,
[email protected]3bb84992010-08-26 17:23:46739 Extension::Location location);
740 ~ExtensionInfo();
[email protected]c6d474f82009-12-16 21:11:06741
742 scoped_ptr<DictionaryValue> extension_manifest;
743 std::string extension_id;
744 FilePath extension_path;
745 Extension::Location extension_location;
746
747 private:
748 DISALLOW_COPY_AND_ASSIGN(ExtensionInfo);
749};
750
[email protected]211030342010-09-30 18:41:06751// Struct used for the details of the EXTENSION_UNINSTALLED
752// notification.
753struct UninstalledExtensionInfo {
754 explicit UninstalledExtensionInfo(const Extension& extension);
[email protected]9b2331d92010-10-04 23:11:19755 ~UninstalledExtensionInfo();
[email protected]211030342010-09-30 18:41:06756
757 std::string extension_id;
758 std::set<std::string> extension_api_permissions;
[email protected]7fa19f82010-12-21 19:40:08759 Extension::Type extension_type;
[email protected]76c25112010-10-01 22:37:21760 GURL update_url;
[email protected]211030342010-09-30 18:41:06761};
762
[email protected]a9f39a312010-12-23 22:14:27763struct UnloadedExtensionInfo {
764 enum Reason {
765 DISABLE, // The extension is being disabled.
766 UPDATE, // The extension is being updated to a newer version.
767 UNINSTALL, // The extension is being uninstalled.
768 };
769
770 Reason reason;
771
772 // Was the extension already disabled?
773 bool already_disabled;
774
775 // The extension being unloaded - this should always be non-NULL.
776 const Extension* extension;
777
778 UnloadedExtensionInfo(const Extension* extension, Reason reason);
779};
780
[email protected]5b1a0e22009-05-26 19:00:58781#endif // CHROME_COMMON_EXTENSIONS_EXTENSION_H_