blob: 6c545e730d1073f39452c65976ae6dc1fea99e6e [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]12802702010-07-09 19:43:0929class SkBitmap;
[email protected]daf66aa2010-08-06 06:24:2830class Version;
[email protected]942690b132010-05-11 06:42:1431
[email protected]f0755532010-06-22 07:27:2532// Represents a Chrome extension.
[email protected]66e4eb32010-10-27 20:37:4133class Extension : public base::RefCountedThreadSafe<Extension> {
[email protected]7713d632008-12-02 07:52:3334 public:
[email protected]d3cfa482009-10-17 13:54:5735 typedef std::map<const std::string, GURL> URLOverrideMap;
[email protected]10fb1992010-10-08 09:00:1736 typedef std::vector<std::string> ScriptingWhitelist;
[email protected]b24d8312009-08-27 06:47:4637
[email protected]631cf822009-05-15 07:01:2538 // What an extension was loaded from.
[email protected]9b217652010-10-08 22:04:2339 // NOTE: These values are stored as integers in the preferences and used
40 // in histograms so don't remove or reorder existing items. Just append
41 // to the end.
[email protected]631cf822009-05-15 07:01:2542 enum Location {
43 INVALID,
[email protected]25b34332009-06-05 21:53:1944 INTERNAL, // A crx file from the internal Extensions directory.
45 EXTERNAL_PREF, // A crx file from an external directory (via prefs).
46 EXTERNAL_REGISTRY, // A crx file from an external directory (via eg the
47 // registry on Windows).
[email protected]1952c7d2010-03-04 23:48:3448 LOAD, // --load-extension.
[email protected]8ef78fd2010-08-19 17:14:3249 COMPONENT, // An integral component of Chrome itself, which
50 // happens to be implemented as an extension. We don't
51 // show these in the management UI.
[email protected]04cb7542010-10-25 10:50:0652 EXTERNAL_PREF_DOWNLOAD, // A crx file from an external directory (via
[email protected]8ef78fd2010-08-19 17:14:3253 // prefs), installed from an update URL.
[email protected]04cb7542010-10-25 10:50:0654 EXTERNAL_POLICY_DOWNLOAD, // A crx file from an external directory (via
55 // admin policies), installed from an update URL.
56
57 NUM_LOCATIONS
[email protected]25b34332009-06-05 21:53:1958 };
59
60 enum State {
[email protected]0c6da502009-08-14 22:32:3961 DISABLED = 0,
[email protected]25b34332009-06-05 21:53:1962 ENABLED,
63 KILLBIT, // Don't install/upgrade (applies to external extensions only).
[email protected]0c6da502009-08-14 22:32:3964
65 NUM_STATES
[email protected]631cf822009-05-15 07:01:2566 };
[email protected]7713d632008-12-02 07:52:3367
[email protected]fbcc40302009-06-12 20:45:4568 enum InstallType {
[email protected]ab6f2b22009-07-28 23:28:3769 INSTALL_ERROR,
[email protected]fbcc40302009-06-12 20:45:4570 DOWNGRADE,
71 REINSTALL,
72 UPGRADE,
73 NEW_INSTALL
74 };
75
[email protected]d2817012009-08-04 06:46:2176 // NOTE: If you change this list, you should also change kIconSizes in the cc
77 // file.
78 enum Icons {
79 EXTENSION_ICON_LARGE = 128,
80 EXTENSION_ICON_MEDIUM = 48,
81 EXTENSION_ICON_SMALL = 32,
[email protected]39382942010-03-23 15:57:0982 EXTENSION_ICON_SMALLISH = 24,
[email protected]d2817012009-08-04 06:46:2183 EXTENSION_ICON_BITTY = 16,
84 };
85
[email protected]9b217652010-10-08 22:04:2386 // Type used for UMA_HISTOGRAM_ENUMERATION about extensions.
87 // Do not change the order of entries or remove entries in this list.
88 enum HistogramType {
89 TYPE_UNKNOWN = 0,
90 TYPE_EXTENSION,
91 TYPE_THEME,
92 TYPE_USER_SCRIPT,
93 TYPE_HOSTED_APP,
94 TYPE_PACKAGED_APP
95 };
96
[email protected]92888082010-10-18 19:24:5797 // An NPAPI plugin included in the extension.
98 struct PluginInfo {
99 FilePath path; // Path to the plugin.
100 bool is_public; // False if only this extension can load this plugin.
101 };
102
[email protected]0df165f2010-09-28 16:49:40103 // A permission is defined by its |name| (what is used in the manifest),
104 // and the |message_id| that's used by install/update UI.
105 struct Permission {
106 const char* const name;
107 const int message_id;
108 };
109
[email protected]66e4eb32010-10-27 20:37:41110 static scoped_refptr<Extension> Create(const FilePath& path,
111 Location location,
112 const DictionaryValue& value,
113 bool require_key,
114 std::string* error);
115
[email protected]0df165f2010-09-28 16:49:40116 // The install message id for |permission|. Returns 0 if none exists.
117 static int GetPermissionMessageId(const std::string& permission);
118
[email protected]a2a098d2010-09-29 19:42:55119 // Returns the full list of permission messages that this extension
120 // should display at install time.
[email protected]9adb9692010-10-29 23:14:02121 std::vector<string16> GetPermissionMessages() const;
[email protected]a2a098d2010-09-29 19:42:55122
123 // Returns the distinct hosts that should be displayed in the install UI. This
124 // discards some of the detail that is present in the manifest to make it as
125 // easy as possible to process by users. In particular we disregard the scheme
126 // and path components of URLPatterns and de-dupe the result.
127 static std::vector<std::string> GetDistinctHosts(
128 const URLPatternList& host_patterns);
[email protected]9adb9692010-10-29 23:14:02129 std::vector<std::string> GetDistinctHosts() const;
[email protected]0df165f2010-09-28 16:49:40130
[email protected]c3e3def742009-07-17 07:51:06131 // Icon sizes used by the extension system.
[email protected]d2817012009-08-04 06:46:21132 static const int kIconSizes[];
[email protected]c3e3def742009-07-17 07:51:06133
[email protected]4c4f8192009-10-17 01:03:26134 // Max size (both dimensions) for browser and page actions.
135 static const int kPageActionIconMaxSize;
136 static const int kBrowserActionIconMaxSize;
137
[email protected]35506352009-08-07 18:58:19138 // Each permission is a module that the extension is permitted to use.
[email protected]218990c2010-06-26 01:21:07139 //
[email protected]0df165f2010-09-28 16:49:40140 // NOTE: To add a new permission, define it here, and add an entry to
141 // Extension::kPermissions.
[email protected]9dcf8f12010-09-02 20:39:19142 static const char kBackgroundPermission[];
143 static const char kBookmarkPermission[];
144 static const char kContextMenusPermission[];
145 static const char kCookiePermission[];
146 static const char kExperimentalPermission[];
147 static const char kGeolocationPermission[];
148 static const char kHistoryPermission[];
149 static const char kIdlePermission[];
[email protected]eb255772010-10-04 22:10:46150 static const char kManagementPermission[];
[email protected]9dcf8f12010-09-02 20:39:19151 static const char kNotificationPermission[];
152 static const char kProxyPermission[];
153 static const char kTabPermission[];
154 static const char kUnlimitedStoragePermission[];
[email protected]9dcf8f12010-09-02 20:39:19155 static const char kWebstorePrivatePermission[];
[email protected]aeb53b32009-10-29 07:34:45156
[email protected]0df165f2010-09-28 16:49:40157 static const Permission kPermissions[];
[email protected]35506352009-08-07 18:58:19158 static const size_t kNumPermissions;
[email protected]9dcf8f12010-09-02 20:39:19159 static const char* const kHostedAppPermissionNames[];
[email protected]b746f372010-08-29 21:39:32160 static const size_t kNumHostedAppPermissions;
[email protected]35506352009-08-07 18:58:19161
[email protected]03b612f2010-08-13 21:09:21162 // The old name for the unlimited storage permission, which is deprecated but
163 // still accepted as meaning the same thing as kUnlimitedStoragePermission.
[email protected]9dcf8f12010-09-02 20:39:19164 static const char kOldUnlimitedStoragePermission[];
[email protected]03b612f2010-08-13 21:09:21165
[email protected]b746f372010-08-29 21:39:32166 // Returns true if the string is one of the known hosted app permissions (see
167 // kHostedAppPermissionNames).
168 static bool IsHostedAppPermission(const std::string& permission);
169
[email protected]6014d672008-12-05 00:38:25170 // The name of the manifest inside an extension.
[email protected]99efb7b12009-12-18 02:39:16171 static const FilePath::CharType kManifestFilename[];
[email protected]6014d672008-12-05 00:38:25172
[email protected]300cc58db2009-08-19 20:45:14173 // The name of locale folder inside an extension.
[email protected]99efb7b12009-12-18 02:39:16174 static const FilePath::CharType kLocaleFolder[];
[email protected]300cc58db2009-08-19 20:45:14175
176 // The name of the messages file inside an extension.
[email protected]99efb7b12009-12-18 02:39:16177 static const FilePath::CharType kMessagesFilename[];
[email protected]300cc58db2009-08-19 20:45:14178
[email protected]25b34332009-06-05 21:53:19179#if defined(OS_WIN)
[email protected]9dcf8f12010-09-02 20:39:19180 static const char kExtensionRegistryPath[];
[email protected]25b34332009-06-05 21:53:19181#endif
182
[email protected]37eeb5a2009-02-26 23:36:17183 // The number of bytes in a legal id.
[email protected]fe0e7822009-02-26 23:51:48184 static const size_t kIdSize;
[email protected]37eeb5a2009-02-26 23:36:17185
[email protected]e435d6b72009-07-25 03:15:58186 // The mimetype used for extensions.
187 static const char kMimeType[];
188
[email protected]25b34332009-06-05 21:53:19189 // Checks to see if the extension has a valid ID.
190 static bool IdIsValid(const std::string& id);
191
[email protected]4ead6f72010-10-13 19:54:18192 // Generate an ID for an extension in the given path.
193 static std::string GenerateIdForPath(const FilePath& file_name);
194
[email protected]e435d6b72009-07-25 03:15:58195 // Returns true if the specified file is an extension.
196 static bool IsExtension(const FilePath& file_name);
197
[email protected]25b34332009-06-05 21:53:19198 // Whether the |location| is external or not.
199 static inline bool IsExternalLocation(Location location) {
200 return location == Extension::EXTERNAL_PREF ||
[email protected]8ef78fd2010-08-19 17:14:32201 location == Extension::EXTERNAL_REGISTRY ||
[email protected]04cb7542010-10-25 10:50:06202 location == Extension::EXTERNAL_PREF_DOWNLOAD ||
203 location == Extension::EXTERNAL_POLICY_DOWNLOAD;
204 }
205
206 // Whether extensions with |location| are auto-updatable or not.
207 static inline bool IsAutoUpdateableLocation(Location location) {
208 // Only internal and external extensions can be autoupdated.
209 return location == Extension::INTERNAL ||
210 IsExternalLocation(location);
[email protected]25b34332009-06-05 21:53:19211 }
212
[email protected]9b217652010-10-08 22:04:23213 // See HistogramType definition above.
[email protected]9adb9692010-10-29 23:14:02214 HistogramType GetHistogramType() const;
[email protected]9b217652010-10-08 22:04:23215
[email protected]07c00d992009-03-04 20:27:04216 // Returns an absolute url to a resource inside of an extension. The
[email protected]eab9b452009-01-23 20:48:59217 // |extension_url| argument should be the url() from an Extension object. The
218 // |relative_path| can be untrusted user input. The returned URL will either
219 // be invalid() or a child of |extension_url|.
220 // NOTE: Static so that it can be used from multiple threads.
221 static GURL GetResourceURL(const GURL& extension_url,
222 const std::string& relative_path);
[email protected]cffd7892010-08-26 17:43:28223 GURL GetResourceURL(const std::string& relative_path) const {
[email protected]3cfbd0e2009-03-18 21:26:24224 return GetResourceURL(url(), relative_path);
225 }
[email protected]eab9b452009-01-23 20:48:59226
[email protected]99efb7b12009-12-18 02:39:16227 // Returns an extension resource object. |relative_path| should be UTF8
228 // encoded.
[email protected]9adb9692010-10-29 23:14:02229 ExtensionResource GetResource(const std::string& relative_path) const;
[email protected]99efb7b12009-12-18 02:39:16230
231 // As above, but with |relative_path| following the file system's encoding.
[email protected]9adb9692010-10-29 23:14:02232 ExtensionResource GetResource(const FilePath& relative_path) const;
[email protected]eab9b452009-01-23 20:48:59233
[email protected]a17f9462009-06-09 02:56:41234 // |input| is expected to be the text of an rsa public or private key. It
235 // tolerates the presence or absence of bracking header/footer like this:
236 // -----(BEGIN|END) [RSA PUBLIC/PRIVATE] KEY-----
237 // and may contain newlines.
238 static bool ParsePEMKeyBytes(const std::string& input, std::string* output);
239
240 // Does a simple base64 encoding of |input| into |output|.
241 static bool ProducePEM(const std::string& input, std::string* output);
242
[email protected]84ac7f32009-10-06 06:17:54243 // Generates an extension ID from arbitrary input. The same input string will
244 // always generate the same output ID.
245 static bool GenerateId(const std::string& input, std::string* output);
[email protected]fbcc40302009-06-12 20:45:45246
[email protected]a17f9462009-06-09 02:56:41247 // Expects base64 encoded |input| and formats into |output| including
248 // the appropriate header & footer.
249 static bool FormatPEMForFileOutput(const std::string input,
250 std::string* output, bool is_public);
251
[email protected]2a409532009-08-28 19:39:44252 // Determine whether |new_extension| has increased privileges compared to
253 // |old_extension|.
[email protected]9adb9692010-10-29 23:14:02254 static bool IsPrivilegeIncrease(const Extension* old_extension,
255 const Extension* new_extension);
[email protected]b24d8312009-08-27 06:47:46256
[email protected]c690a9812009-12-17 05:55:32257 // Given an extension and icon size, read it if present and decode it into
[email protected]ae2e0f92010-04-06 20:32:23258 // result. In the browser process, this will DCHECK if not called on the
259 // file thread. To easily load extension images on the UI thread, see
260 // ImageLoadingTracker.
[email protected]9adb9692010-10-29 23:14:02261 static void DecodeIcon(const Extension* extension,
[email protected]c690a9812009-12-17 05:55:32262 Icons icon_size,
263 scoped_ptr<SkBitmap>* result);
264
265 // Given an icon_path and icon size, read it if present and decode it into
[email protected]ae2e0f92010-04-06 20:32:23266 // result. In the browser process, this will DCHECK if not called on the
267 // file thread. To easily load extension images on the UI thread, see
268 // ImageLoadingTracker.
[email protected]c690a9812009-12-17 05:55:32269 static void DecodeIconFromPath(const FilePath& icon_path,
270 Icons icon_size,
271 scoped_ptr<SkBitmap>* result);
272
[email protected]a807bbe2010-04-14 10:51:19273 // Returns the base extension url for a given |extension_id|.
274 static GURL GetBaseURLFromExtensionId(const std::string& extension_id);
275
[email protected]ec5b50d2010-10-09 16:35:18276 // Returns the url prefix for the extension/apps gallery. Can be set via the
[email protected]ce3eb7b62010-09-14 13:57:44277 // --apps-gallery-url switch. The URL returned will not contain a trailing
[email protected]d3071992010-10-08 15:24:07278 // slash. Do not use this as a prefix/extent for the store. Instead see
279 // ExtensionsService::GetWebStoreApp or
280 // ExtensionsService::IsDownloadFromGallery
281 static std::string ChromeStoreLaunchURL();
[email protected]a0cf04a2010-06-23 03:29:55282
[email protected]be7e5cb2010-10-04 12:53:17283 // Helper function that consolidates the check for whether the script can
284 // execute into one location. |page_url| is the page that is the candidate
285 // for running the script, |can_execute_script_everywhere| specifies whether
286 // the extension is on the whitelist, |allowed_pages| is a vector of
287 // URLPatterns, listing what access the extension has, |script| is the script
288 // pointer (if content script) and |error| is an optional parameter, which
289 // will receive the error string listing why access was denied.
290 static bool CanExecuteScriptOnPage(
291 const GURL& page_url,
292 bool can_execute_script_everywhere,
293 const std::vector<URLPattern>* allowed_pages,
294 UserScript* script,
295 std::string* error);
296
297 // Adds an extension to the scripting whitelist. Used for testing only.
[email protected]10fb1992010-10-08 09:00:17298 static void SetScriptingWhitelist(const ScriptingWhitelist& whitelist);
[email protected]be7e5cb2010-10-04 12:53:17299
[email protected]aeb53b32009-10-29 07:34:45300 // Returns true if the extension has the specified API permission.
[email protected]0df165f2010-09-28 16:49:40301 static bool HasApiPermission(const std::set<std::string>& api_permissions,
[email protected]246c05f2010-09-10 09:12:11302 const std::string& function_name);
[email protected]583d45c12010-08-31 02:48:12303
[email protected]246c05f2010-09-10 09:12:11304 bool HasApiPermission(const std::string& function_name) const {
305 return HasApiPermission(this->api_permissions(), function_name);
[email protected]aeb53b32009-10-29 07:34:45306 }
307
[email protected]4361c7c2010-09-30 21:57:53308 const ExtensionExtent& GetEffectiveHostPermissions() const {
[email protected]6f229e82010-11-02 17:47:26309 return effective_host_permissions_;
[email protected]4361c7c2010-09-30 21:57:53310 }
[email protected]b24d8312009-08-27 06:47:46311
[email protected]fbd17cf2010-04-28 23:52:56312 // Whether or not the extension is allowed permission for a URL pattern from
313 // the manifest. http, https, and chrome://favicon/ is allowed for all
314 // extensions, while component extensions are allowed access to
315 // chrome://resources.
[email protected]a3caa822010-10-26 18:10:00316 bool CanSpecifyHostPermission(const URLPattern& pattern) const;
[email protected]fbd17cf2010-04-28 23:52:56317
[email protected]584b8e3f2010-04-10 00:23:37318 // Whether the extension has access to the given URL.
319 bool HasHostPermission(const GURL& url) const;
320
[email protected]0df165f2010-09-28 16:49:40321 // Whether the extension has effective access to all hosts. This is true if
322 // there is a content script that matches all hosts, if there is a host
323 // permission grants access to all hosts (like <all_urls>) or an api
324 // permission that effectively grants access to all hosts (e.g. proxy,
325 // network, etc.)
326 bool HasEffectiveAccessToAllHosts() const;
[email protected]b24d8312009-08-27 06:47:46327
[email protected]37cd64d2010-10-25 18:17:58328 // Returns the Homepage URL for this extension. If homepage_url was not
329 // specified in the manifest, this returns the Google Gallery URL. For
[email protected]bfa90a3a2010-04-28 15:43:23330 // third-party extensions, this returns a blank GURL.
[email protected]37cd64d2010-10-25 18:17:58331 GURL GetHomepageURL() const;
[email protected]bfa90a3a2010-04-28 15:43:23332
[email protected]facd7a7652009-06-05 23:15:02333 // Returns a list of paths (relative to the extension dir) for images that
334 // the browser might load (like themes and page action icons).
[email protected]9adb9692010-10-29 23:14:02335 std::set<FilePath> GetBrowserImages() const;
[email protected]facd7a7652009-06-05 23:15:02336
[email protected]807871f2010-09-16 01:04:48337 // Get an extension icon as a resource or URL.
[email protected]9adb9692010-10-29 23:14:02338 ExtensionResource GetIconResource(
339 int size, ExtensionIconSet::MatchType match_type) const;
340 GURL GetIconURL(int size, ExtensionIconSet::MatchType match_type) const;
[email protected]f34e79632010-03-17 02:34:08341
[email protected]867a73e12010-03-19 20:45:46342 // Gets the fully resolved absolute launch URL.
343 GURL GetFullLaunchURL() const;
[email protected]6f229e82010-11-02 17:47:26344 // Image cache related methods. These are only valid on the UI thread and
345 // not maintained by this class. See ImageLoadingTracker for usage. The
346 // |original_size| parameter should be the size of the image at |source|
347 // before any scaling may have been done to produce the pixels in |image|.
348 void SetCachedImage(const ExtensionResource& source,
349 const SkBitmap& image,
350 const gfx::Size& original_size) const;
351 bool HasCachedImage(const ExtensionResource& source,
352 const gfx::Size& max_size) const;
353 SkBitmap GetCachedImage(const ExtensionResource& source,
354 const gfx::Size& max_size) const;
355 // Returns true if this extension is a COMPONENT extension, or if it is
356 // on the whitelist of extensions that can script all pages.
357 bool CanExecuteScriptEverywhere() const;
358
[email protected]a65882c2010-11-12 15:15:09359 // Returns true if this extension updates itself using the extension
360 // gallery.
361 bool UpdatesFromGallery() const;
362
[email protected]6f229e82010-11-02 17:47:26363 // Accessors:
364
365 const FilePath& path() const { return path_; }
366 const GURL& url() const { return extension_url_; }
367 Location location() const { return location_; }
368 const std::string& id() const { return id_; }
369 const Version* version() const { return version_.get(); }
370 const std::string VersionString() const;
371 const std::string& name() const { return name_; }
372 const std::string& public_key() const { return public_key_; }
373 const std::string& description() const { return description_; }
374 bool converted_from_user_script() const {
375 return converted_from_user_script_;
376 }
377 const UserScriptList& content_scripts() const { return content_scripts_; }
378 ExtensionAction* page_action() const { return page_action_.get(); }
379 ExtensionAction* browser_action() const { return browser_action_.get(); }
380 const std::vector<PluginInfo>& plugins() const { return plugins_; }
381 const GURL& background_url() const { return background_url_; }
382 const GURL& options_url() const { return options_url_; }
383 const GURL& devtools_url() const { return devtools_url_; }
384 const std::vector<GURL>& toolstrips() const { return toolstrips_; }
385 const std::set<std::string>& api_permissions() const {
386 return api_permissions_;
387 }
388 const URLPatternList& host_permissions() const { return host_permissions_; }
389 const GURL& update_url() const { return update_url_; }
390 const ExtensionIconSet& icons() const { return icons_; }
391 const DictionaryValue* manifest_value() const {
392 return manifest_value_.get();
393 }
394 const std::string default_locale() const { return default_locale_; }
395 const URLOverrideMap& GetChromeURLOverrides() const {
396 return chrome_url_overrides_;
397 }
398 const std::string omnibox_keyword() const { return omnibox_keyword_; }
399 bool incognito_split_mode() const { return incognito_split_mode_; }
400
401 // App-related.
402 bool is_app() const { return is_app_; }
403 bool is_hosted_app() const { return is_app() && !web_extent().is_empty(); }
404 bool is_packaged_app() const { return is_app() && web_extent().is_empty(); }
405 const ExtensionExtent& web_extent() const { return extent_; }
406 const std::string& launch_local_path() const { return launch_local_path_; }
407 const std::string& launch_web_url() const { return launch_web_url_; }
408 extension_misc::LaunchContainer launch_container() const {
409 return launch_container_;
410 }
411 int launch_width() const { return launch_width_; }
412 int launch_height() const { return launch_height_; }
413
414 // Theme-related.
415 bool is_theme() const { return is_theme_; }
416 DictionaryValue* GetThemeImages() const { return theme_images_.get(); }
417 DictionaryValue* GetThemeColors() const {return theme_colors_.get(); }
418 DictionaryValue* GetThemeTints() const { return theme_tints_.get(); }
419 DictionaryValue* GetThemeDisplayProperties() const {
420 return theme_display_properties_.get();
421 }
422
[email protected]4a8d3272009-03-10 19:15:08423 private:
[email protected]66e4eb32010-10-27 20:37:41424 friend class base::RefCountedThreadSafe<Extension>;
425
[email protected]d7e9a862010-11-03 21:57:49426 // We keep a cache of images loaded from extension resources based on their
427 // path and a string representation of a size that may have been used to
428 // scale it (or the empty string if the image is at its original size).
429 typedef std::pair<FilePath, std::string> ImageCacheKey;
430 typedef std::map<ImageCacheKey, SkBitmap> ImageCache;
431
[email protected]4ead6f72010-10-13 19:54:18432 // Normalize the path for use by the extension. On Windows, this will make
433 // sure the drive letter is uppercase.
434 static FilePath MaybeNormalizePath(const FilePath& path);
435
[email protected]66e4eb32010-10-27 20:37:41436 Extension(const FilePath& path, Location location);
437 ~Extension();
438
439 // Initialize the extension from a parsed manifest.
440 // Usually, the id of an extension is generated by the "key" property of
441 // its manifest, but if |require_key| is |false|, a temporary ID will be
442 // generated based on the path.
443 bool InitFromValue(const DictionaryValue& value, bool require_key,
444 std::string* error);
445
[email protected]052c92702010-06-25 07:25:52446 // Helper function for implementing HasCachedImage/GetCachedImage. A return
447 // value of NULL means there is no matching image cached (we allow caching an
448 // empty SkBitmap).
449 SkBitmap* GetCachedImageImpl(const ExtensionResource& source,
[email protected]9adb9692010-10-29 23:14:02450 const gfx::Size& max_size) const;
[email protected]d9ad80f2010-03-30 20:40:18451
[email protected]3cfbd0e2009-03-18 21:26:24452 // Helper method that loads a UserScript object from a
453 // dictionary in the content_script list of the manifest.
454 bool LoadUserScriptHelper(const DictionaryValue* content_script,
455 int definition_index,
456 std::string* error,
457 UserScript* result);
[email protected]f7f3a5f2009-05-01 22:02:34458
[email protected]6657afa62009-11-04 02:15:20459 // Helper method that loads either the include_globs or exclude_globs list
460 // from an entry in the content_script lists of the manifest.
461 bool LoadGlobsHelper(const DictionaryValue* content_script,
462 int content_script_index,
[email protected]e2194742010-08-12 05:54:34463 const char* globs_property_name,
[email protected]6657afa62009-11-04 02:15:20464 std::string* error,
[email protected]11f4857282009-11-13 19:56:17465 void(UserScript::*add_method)(const std::string& glob),
[email protected]6657afa62009-11-04 02:15:20466 UserScript *instance);
467
[email protected]867a73e12010-03-19 20:45:46468 // Helpers to load various chunks of the manifest.
[email protected]3ba0fd32010-06-19 05:39:10469 bool LoadIsApp(const DictionaryValue* manifest, std::string* error);
[email protected]e2194742010-08-12 05:54:34470 bool LoadExtent(const DictionaryValue* manifest, const char* key,
[email protected]4fdbc1492010-07-01 01:20:59471 ExtensionExtent* extent, const char* list_error,
472 const char* value_error, std::string* error);
[email protected]867a73e12010-03-19 20:45:46473 bool LoadLaunchContainer(const DictionaryValue* manifest, std::string* error);
474 bool LoadLaunchURL(const DictionaryValue* manifest, std::string* error);
[email protected]cbf4d1912010-08-12 18:24:57475 bool EnsureNotHybridApp(const DictionaryValue* manifest, std::string* error);
[email protected]867a73e12010-03-19 20:45:46476
[email protected]5d246db22009-10-27 06:17:57477 // Helper method to load an ExtensionAction from the page_action or
[email protected]92c6f9b92009-10-24 04:35:08478 // browser_action entries in the manifest.
[email protected]5d246db22009-10-27 06:17:57479 ExtensionAction* LoadExtensionActionHelper(
[email protected]92c6f9b92009-10-24 04:35:08480 const DictionaryValue* extension_action, std::string* error);
481
[email protected]4361c7c2010-09-30 21:57:53482 // Calculates the effective host permissions from the permissions and content
483 // script petterns.
484 void InitEffectiveHostPermissions();
485
[email protected]2f6698b2010-10-14 00:58:21486 // Returns true if the extension has more than one "UI surface". For example,
487 // an extension that has a browser action and a page action.
488 bool HasMultipleUISurfaces() const;
489
[email protected]e2eb43112009-05-29 21:19:54490 // Figures out if a source contains keys not associated with themes - we
491 // don't want to allow scripts and such to be bundled with themes.
[email protected]9adb9692010-10-29 23:14:02492 bool ContainsNonThemeKeys(const DictionaryValue& source) const;
[email protected]e2eb43112009-05-29 21:19:54493
[email protected]1952c7d2010-03-04 23:48:34494 // Returns true if the string is one of the known api permissions (see
[email protected]0df165f2010-09-28 16:49:40495 // kPermissions).
[email protected]9adb9692010-10-29 23:14:02496 bool IsAPIPermission(const std::string& permission) const;
[email protected]1952c7d2010-03-04 23:48:34497
[email protected]a2a098d2010-09-29 19:42:55498 // The set of unique API install messages that the extension has.
499 // NOTE: This only includes messages related to permissions declared in the
500 // "permissions" key in the manifest. Permissions implied from other features
501 // of the manifest, like plugins and content scripts are not included.
[email protected]9adb9692010-10-29 23:14:02502 std::set<string16> GetSimplePermissionMessages() const;
[email protected]a2a098d2010-09-29 19:42:55503
504 // The permission message displayed related to the host permissions for
505 // this extension.
[email protected]9adb9692010-10-29 23:14:02506 string16 GetHostPermissionMessage() const;
[email protected]a2a098d2010-09-29 19:42:55507
[email protected]d7e9a862010-11-03 21:57:49508 // Cached images for this extension. This should only be touched on the UI
509 // thread.
510 mutable ImageCache image_cache_;
[email protected]1e8c93f2010-02-08 22:58:31511
[email protected]6f229e82010-11-02 17:47:26512 // A persistent, globally unique ID. An extension's ID is used in things
513 // like directory structures and URLs, and is expected to not change across
514 // versions. It is generated as a SHA-256 hash of the extension's public
515 // key, or as a hash of the path in the case of unpacked extensions.
516 std::string id_;
517
518 // The extension's human-readable name. Name is used for display purpose. It
519 // might be wrapped with unicode bidi control characters so that it is
520 // displayed correctly in RTL context.
521 // NOTE: Name is UTF-8 and may contain non-ascii characters.
522 std::string name_;
523
524 // The absolute path to the directory the extension is stored in.
525 FilePath path_;
526
527 // Default locale for fall back. Can be empty if extension is not localized.
528 std::string default_locale_;
529
530 // If true, a separate process will be used for the extension in incognito
531 // mode.
532 bool incognito_split_mode_;
533
534 // Defines the set of URLs in the extension's web content.
535 ExtensionExtent extent_;
536
537 // The set of host permissions that the extension effectively has access to,
538 // which is a merge of host_permissions_ and all of the match patterns in
539 // any content scripts the extension has. This is used to determine which
540 // URLs have the ability to load an extension's resources via embedded
541 // chrome-extension: URLs (see extension_protocols.cc).
542 ExtensionExtent effective_host_permissions_;
543
544 // The set of module-level APIs this extension can use.
545 std::set<std::string> api_permissions_;
546
547 // The icons for the extension.
548 ExtensionIconSet icons_;
549
550 // The base extension url for the extension.
551 GURL extension_url_;
552
553 // The location the extension was loaded from.
554 Location location_;
555
556 // The extension's version.
557 scoped_ptr<Version> version_;
558
559 // An optional longer description of the extension.
560 std::string description_;
561
562 // True if the extension was generated from a user script. (We show slightly
563 // different UI if so).
564 bool converted_from_user_script_;
565
566 // Paths to the content scripts the extension contains.
567 UserScriptList content_scripts_;
568
569 // The extension's page action, if any.
570 scoped_ptr<ExtensionAction> page_action_;
571
572 // The extension's browser action, if any.
573 scoped_ptr<ExtensionAction> browser_action_;
574
575 // Optional list of NPAPI plugins and associated properties.
576 std::vector<PluginInfo> plugins_;
577
578 // Optional URL to a master page of which a single instance should be always
579 // loaded in the background.
580 GURL background_url_;
581
582 // Optional URL to a page for setting options/preferences.
583 GURL options_url_;
584
585 // Optional URL to a devtools extension page.
586 GURL devtools_url_;
587
588 // Optional list of toolstrips and associated properties.
589 std::vector<GURL> toolstrips_;
590
591 // The public key used to sign the contents of the crx package.
592 std::string public_key_;
593
594 // A map of resource id's to relative file paths.
595 scoped_ptr<DictionaryValue> theme_images_;
596
597 // A map of color names to colors.
598 scoped_ptr<DictionaryValue> theme_colors_;
599
600 // A map of color names to colors.
601 scoped_ptr<DictionaryValue> theme_tints_;
602
603 // A map of display properties.
604 scoped_ptr<DictionaryValue> theme_display_properties_;
605
606 // Whether the extension is a theme.
607 bool is_theme_;
608
609 // The sites this extension has permission to talk to (using XHR, etc).
610 URLPatternList host_permissions_;
611
612 // The homepage for this extension. Useful if it is not hosted by Google and
613 // therefore does not have a Gallery URL.
614 GURL homepage_url_;
615
616 // URL for fetching an update manifest
617 GURL update_url_;
618
619 // A copy of the manifest that this extension was created from.
620 scoped_ptr<DictionaryValue> manifest_value_;
621
622 // A map of chrome:// hostnames (newtab, downloads, etc.) to Extension URLs
623 // which override the handling of those URLs. (see ExtensionOverrideUI).
624 URLOverrideMap chrome_url_overrides_;
625
626 // Whether this extension uses app features.
627 bool is_app_;
628
629 // The local path inside the extension to use with the launcher.
630 std::string launch_local_path_;
631
632 // A web url to use with the launcher. Note that this might be relative or
633 // absolute. If relative, it is relative to web_origin.
634 std::string launch_web_url_;
635
636 // The type of container to launch into.
637 extension_misc::LaunchContainer launch_container_;
638
639 // The default size of the container when launching. Only respected for
640 // containers like panels and windows.
641 int launch_width_;
642 int launch_height_;
643
644 // The Omnibox keyword for this extension, or empty if there is none.
645 std::string omnibox_keyword_;
646
[email protected]19118d52010-07-26 22:13:42647 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, LoadPageActionHelper);
[email protected]66e4eb32010-10-27 20:37:41648 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueInvalid);
649 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueValid);
650 FRIEND_TEST_ALL_PREFIXES(ExtensionTest, InitFromValueValidNameInRTL);
[email protected]19118d52010-07-26 22:13:42651 FRIEND_TEST_ALL_PREFIXES(TabStripModelTest, Apps);
[email protected]ae7fe712009-07-02 20:33:58652
[email protected]894bb502009-05-21 22:39:57653 DISALLOW_COPY_AND_ASSIGN(Extension);
[email protected]7713d632008-12-02 07:52:33654};
655
[email protected]9adb9692010-10-29 23:14:02656typedef std::vector< scoped_refptr<const Extension> > ExtensionList;
[email protected]ec5b50d2010-10-09 16:35:18657typedef std::set<std::string> ExtensionIdSet;
[email protected]b1748b1d82009-11-30 20:32:56658
[email protected]c6d474f82009-12-16 21:11:06659// Handy struct to pass core extension info around.
660struct ExtensionInfo {
661 ExtensionInfo(const DictionaryValue* manifest,
662 const std::string& id,
663 const FilePath& path,
[email protected]3bb84992010-08-26 17:23:46664 Extension::Location location);
665 ~ExtensionInfo();
[email protected]c6d474f82009-12-16 21:11:06666
667 scoped_ptr<DictionaryValue> extension_manifest;
668 std::string extension_id;
669 FilePath extension_path;
670 Extension::Location extension_location;
671
672 private:
673 DISALLOW_COPY_AND_ASSIGN(ExtensionInfo);
674};
675
[email protected]211030342010-09-30 18:41:06676// Struct used for the details of the EXTENSION_UNINSTALLED
677// notification.
678struct UninstalledExtensionInfo {
679 explicit UninstalledExtensionInfo(const Extension& extension);
[email protected]9b2331d92010-10-04 23:11:19680 ~UninstalledExtensionInfo();
[email protected]211030342010-09-30 18:41:06681
682 std::string extension_id;
683 std::set<std::string> extension_api_permissions;
[email protected]76c25112010-10-01 22:37:21684 // TODO(akalin): Once we have a unified ExtensionType, replace the
685 // below member variables with a member of that type.
686 bool is_theme;
687 bool is_app;
688 bool converted_from_user_script;
689 GURL update_url;
[email protected]211030342010-09-30 18:41:06690};
691
[email protected]5b1a0e22009-05-26 19:00:58692#endif // CHROME_COMMON_EXTENSIONS_EXTENSION_H_