[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 1 | // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. |
2 | // Use of this source code is governed by a BSD-style license that can be | ||||
3 | // found in the LICENSE file. | ||||
4 | |||||
[email protected] | 6014d67 | 2008-12-05 00:38:25 | [diff] [blame] | 5 | #ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_H_ |
6 | #define CHROME_BROWSER_EXTENSIONS_EXTENSION_H_ | ||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 7 | |
8 | #include <string> | ||||
9 | #include <vector> | ||||
10 | |||||
[email protected] | 6014d67 | 2008-12-05 00:38:25 | [diff] [blame] | 11 | #include "base/file_path.h" |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 12 | #include "base/scoped_ptr.h" |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 13 | #include "base/string16.h" |
14 | #include "base/values.h" | ||||
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 15 | #include "base/version.h" |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 16 | #include "chrome/browser/extensions/user_script_master.h" |
17 | #include "googleurl/src/gurl.h" | ||||
18 | |||||
19 | // The URL schemes Chromium extensions and user scripts are served from. These | ||||
20 | // really should be in extension_protocols.h, but that causes link errors on | ||||
21 | // linux because extension_protocols.cc refers to undefined symbols. | ||||
22 | // TODO(aa): Move these back to extension_protocols.h when more of Linux and | ||||
23 | // Mac are up and running. | ||||
24 | extern const char kExtensionURLScheme[]; | ||||
25 | extern const char kUserScriptURLScheme[]; | ||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 26 | |
27 | // Represents a Chromium extension. | ||||
28 | class Extension { | ||||
29 | public: | ||||
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 30 | Extension() {} |
31 | explicit Extension(const FilePath& path); | ||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 32 | |
33 | // The format for extension manifests that this code understands. | ||||
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 34 | static const unsigned int kExpectedFormatVersion = 1; |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 35 | |
[email protected] | 6014d67 | 2008-12-05 00:38:25 | [diff] [blame] | 36 | // The name of the manifest inside an extension. |
[email protected] | 0e29223 | 2009-01-22 15:23:34 | [diff] [blame] | 37 | static const char kManifestFilename[]; |
[email protected] | 6014d67 | 2008-12-05 00:38:25 | [diff] [blame] | 38 | |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 39 | // Keys used in JSON representation of extensions. |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 40 | static const wchar_t* kDescriptionKey; |
41 | static const wchar_t* kFilesKey; | ||||
[email protected] | 1712232 | 2009-01-22 20:03:30 | [diff] [blame] | 42 | static const wchar_t* kFormatVersionKey; |
43 | static const wchar_t* kIdKey; | ||||
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 44 | static const wchar_t* kMatchesKey; |
[email protected] | 1712232 | 2009-01-22 20:03:30 | [diff] [blame] | 45 | static const wchar_t* kNameKey; |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 46 | static const wchar_t* kUserScriptsKey; |
[email protected] | 0afe827 | 2009-02-14 04:15:16 | [diff] [blame^] | 47 | static const wchar_t* kRunAtKey; |
[email protected] | 1712232 | 2009-01-22 20:03:30 | [diff] [blame] | 48 | static const wchar_t* kVersionKey; |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 49 | static const wchar_t* kZipHashKey; |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 50 | |
[email protected] | 0afe827 | 2009-02-14 04:15:16 | [diff] [blame^] | 51 | // Some values expected in manifests. |
52 | static const char* kRunAtDocumentStartValue; | ||||
53 | static const char* kRunAtDocumentEndValue; | ||||
54 | |||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 55 | // Error messages returned from InitFromValue(). |
[email protected] | 1712232 | 2009-01-22 20:03:30 | [diff] [blame] | 56 | static const char* kInvalidDescriptionError; |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 57 | static const char* kInvalidFileCountError; |
58 | static const char* kInvalidFileError; | ||||
59 | static const char* kInvalidFilesError; | ||||
60 | static const char* kInvalidFormatVersionError; | ||||
61 | static const char* kInvalidIdError; | ||||
62 | static const char* kInvalidManifestError; | ||||
63 | static const char* kInvalidMatchCountError; | ||||
64 | static const char* kInvalidMatchError; | ||||
65 | static const char* kInvalidMatchesError; | ||||
66 | static const char* kInvalidNameError; | ||||
[email protected] | 0afe827 | 2009-02-14 04:15:16 | [diff] [blame^] | 67 | static const char* kInvalidRunAtError; |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 68 | static const char* kInvalidUserScriptError; |
69 | static const char* kInvalidUserScriptsListError; | ||||
[email protected] | 1712232 | 2009-01-22 20:03:30 | [diff] [blame] | 70 | static const char* kInvalidVersionError; |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 71 | static const char* kInvalidZipHashError; |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 72 | |
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 73 | // Creates an absolute url to a resource inside an extension. The |
74 | // |extension_url| argument should be the url() from an Extension object. The | ||||
75 | // |relative_path| can be untrusted user input. The returned URL will either | ||||
76 | // be invalid() or a child of |extension_url|. | ||||
77 | // NOTE: Static so that it can be used from multiple threads. | ||||
78 | static GURL GetResourceURL(const GURL& extension_url, | ||||
79 | const std::string& relative_path); | ||||
80 | |||||
81 | // Creates an absolute path to a resource inside an extension. The | ||||
82 | // |extension_path| argument should be the path() from an Extension object. | ||||
83 | // The |relative_path| can be untrusted user input. The returned path will | ||||
84 | // either be empty or a child of extension_path. | ||||
85 | // NOTE: Static so that it can be used from multiple threads. | ||||
86 | static FilePath GetResourcePath(const FilePath& extension_path, | ||||
87 | const std::string& relative_path); | ||||
88 | |||||
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 89 | // The path to the folder the extension is stored in. |
90 | const FilePath& path() const { return path_; } | ||||
91 | |||||
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 92 | // The base URL for the extension. |
93 | const GURL& url() const { return extension_url_; } | ||||
94 | |||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 95 | // A human-readable ID for the extension. The convention is to use something |
96 | // like 'com.example.myextension', but this is not currently enforced. An | ||||
97 | // extension's ID is used in things like directory structures and URLs, and | ||||
98 | // is expected to not change across versions. In the case of conflicts, | ||||
99 | // updates will only be allowed if the extension can be validated using the | ||||
100 | // previous version's update key. | ||||
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 101 | const std::string& id() const { return id_; } |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 102 | |
[email protected] | 64a02b80 | 2009-01-12 19:36:42 | [diff] [blame] | 103 | // The version number for the extension. |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 104 | const Version* version() const { return version_.get(); } |
105 | |||||
106 | // String representation of the version number. | ||||
107 | const std::string VersionString() const; | ||||
[email protected] | 64a02b80 | 2009-01-12 19:36:42 | [diff] [blame] | 108 | |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 109 | // A human-readable name of the extension. |
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 110 | const std::string& name() const { return name_; } |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 111 | |
112 | // An optional longer description of the extension. | ||||
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 113 | const std::string& description() const { return description_; } |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 114 | |
115 | // Paths to the content scripts that the extension contains. | ||||
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 116 | const UserScriptList& user_scripts() const { |
117 | return user_scripts_; | ||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 118 | } |
119 | |||||
120 | // Initialize the extension from a parsed manifest. | ||||
[email protected] | 3acbd42 | 2008-12-08 18:25:00 | [diff] [blame] | 121 | bool InitFromValue(const DictionaryValue& value, std::string* error); |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 122 | |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 123 | private: |
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 124 | // The path to the directory the extension is stored in. |
125 | FilePath path_; | ||||
126 | |||||
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 127 | // The base extension url for the extension. |
128 | GURL extension_url_; | ||||
129 | |||||
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 130 | // The extension's ID. |
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 131 | std::string id_; |
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 132 | |
[email protected] | 64a02b80 | 2009-01-12 19:36:42 | [diff] [blame] | 133 | // The extension's version. |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 134 | scoped_ptr<Version> version_; |
[email protected] | 64a02b80 | 2009-01-12 19:36:42 | [diff] [blame] | 135 | |
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 136 | // The extension's human-readable name. |
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 137 | std::string name_; |
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 138 | |
139 | // An optional description for the extension. | ||||
[email protected] | e1cec06c | 2008-12-18 01:22:23 | [diff] [blame] | 140 | std::string description_; |
[email protected] | 8289126 | 2008-12-24 00:21:26 | [diff] [blame] | 141 | |
142 | // Paths to the content scripts the extension contains. | ||||
[email protected] | eab9b45 | 2009-01-23 20:48:59 | [diff] [blame] | 143 | UserScriptList user_scripts_; |
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 144 | |
[email protected] | cc65591 | 2009-01-29 23:19:19 | [diff] [blame] | 145 | // A SHA1 hash of the contents of the zip file. Note that this key is only |
146 | // present in the manifest that's prepended to the zip. The inner manifest | ||||
147 | // will not have this key. | ||||
148 | std::string zip_hash_; | ||||
149 | |||||
[email protected] | 7713d63 | 2008-12-02 07:52:33 | [diff] [blame] | 150 | DISALLOW_COPY_AND_ASSIGN(Extension); |
151 | }; | ||||
152 | |||||
[email protected] | 6014d67 | 2008-12-05 00:38:25 | [diff] [blame] | 153 | #endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_H_ |