blob: 7887f872e50d12861cb44733bbf765a098cc5f91 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_H_
#define CHROME_BROWSER_EXTENSIONS_EXTENSION_H_
#include <string>
#include <vector>
#include "base/file_path.h"
#include "base/string16.h"
#include "base/values.h"
#include "chrome/browser/extensions/user_script_master.h"
#include "googleurl/src/gurl.h"
// Represents a Chromium extension.
class Extension {
public:
Extension(const FilePath& path);
// The format for extension manifests that this code understands.
static const int kExpectedFormatVersion = 1;
// The name of the manifest inside an extension.
static const char kManifestFilename[];
// Keys used in JSON representation of extensions.
static const wchar_t* kDescriptionKey;
static const wchar_t* kFilesKey;
static const wchar_t* kFormatVersionKey;
static const wchar_t* kIdKey;
static const wchar_t* kMatchesKey;
static const wchar_t* kNameKey;
static const wchar_t* kUserScriptsKey;
static const wchar_t* kVersionKey;
// Error messages returned from InitFromValue().
static const char* kInvalidDescriptionError;
static const char* kInvalidFileCountError;
static const char* kInvalidFileError;
static const char* kInvalidFilesError;
static const char* kInvalidFormatVersionError;
static const char* kInvalidIdError;
static const char* kInvalidManifestError;
static const char* kInvalidMatchCountError;
static const char* kInvalidMatchError;
static const char* kInvalidMatchesError;
static const char* kInvalidNameError;
static const char* kInvalidUserScriptError;
static const char* kInvalidUserScriptsListError;
static const char* kInvalidVersionError;
// Creates an absolute url to a resource inside an extension. The
// |extension_url| argument should be the url() from an Extension object. The
// |relative_path| can be untrusted user input. The returned URL will either
// be invalid() or a child of |extension_url|.
// NOTE: Static so that it can be used from multiple threads.
static GURL GetResourceURL(const GURL& extension_url,
const std::string& relative_path);
// Creates an absolute path to a resource inside an extension. The
// |extension_path| argument should be the path() from an Extension object.
// The |relative_path| can be untrusted user input. The returned path will
// either be empty or a child of extension_path.
// NOTE: Static so that it can be used from multiple threads.
static FilePath GetResourcePath(const FilePath& extension_path,
const std::string& relative_path);
// The path to the folder the extension is stored in.
const FilePath& path() const { return path_; }
// The base URL for the extension.
const GURL& url() const { return extension_url_; }
// A human-readable ID for the extension. The convention is to use something
// like 'com.example.myextension', but this is not currently enforced. An
// extension's ID is used in things like directory structures and URLs, and
// is expected to not change across versions. In the case of conflicts,
// updates will only be allowed if the extension can be validated using the
// previous version's update key.
const std::string& id() const { return id_; }
// The version number for the extension.
const std::string& version() const { return version_; }
// A human-readable name of the extension.
const std::string& name() const { return name_; }
// An optional longer description of the extension.
const std::string& description() const { return description_; }
// Paths to the content scripts that the extension contains.
const UserScriptList& user_scripts() const {
return user_scripts_;
}
// Initialize the extension from a parsed manifest.
bool InitFromValue(const DictionaryValue& value, std::string* error);
private:
// The path to the directory the extension is stored in.
FilePath path_;
// The base extension url for the extension.
GURL extension_url_;
// The extension's ID.
std::string id_;
// The extension's version.
std::string version_;
// The extension's human-readable name.
std::string name_;
// An optional description for the extension.
std::string description_;
// Paths to the content scripts the extension contains.
UserScriptList user_scripts_;
DISALLOW_COPY_AND_ASSIGN(Extension);
};
#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_H_
|
