1 // Copyright 2013 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 5 #ifndef EXTENSIONS_COMMON_EXTENSION_API_H_ 6 #define EXTENSIONS_COMMON_EXTENSION_API_H_ 7 8 #include <map> 9 #include <string> 10 11 #include "base/basictypes.h" 12 #include "base/gtest_prod_util.h" 13 #include "base/memory/linked_ptr.h" 14 #include "base/memory/scoped_ptr.h" 15 #include "base/memory/singleton.h" 16 #include "base/strings/string_piece.h" 17 #include "base/values.h" 18 #include "extensions/common/features/feature.h" 19 #include "extensions/common/features/feature_provider.h" 20 #include "extensions/common/url_pattern_set.h" 21 22 namespace base { 23 class DictionaryValue; 24 class Value; 25 } 26 27 class GURL; 28 29 namespace extensions { 30 31 class Extension; 32 class Feature; 33 34 // C++ Wrapper for the JSON API definitions in chrome/common/extensions/api/. 35 // 36 // WARNING: This class is accessed on multiple threads in the browser process 37 // (see ExtensionFunctionDispatcher). No state should be modified after 38 // construction. 39 class ExtensionAPI { 40 public: 41 // Returns a single shared instance of this class. This is the typical use 42 // case in Chrome. 43 // 44 // TODO(aa): Make this const to enforce thread-safe usage. 45 static ExtensionAPI* GetSharedInstance(); 46 47 // Creates a new instance configured the way ExtensionAPI typically is in 48 // Chrome. Use the default constructor to get a clean instance. 49 static ExtensionAPI* CreateWithDefaultConfiguration(); 50 51 // Splits a name like "permission:bookmark" into ("permission", "bookmark"). 52 // The first part refers to a type of feature, for example "manifest", 53 // "permission", or "api". The second part is the full name of the feature. 54 static void SplitDependencyName(const std::string& full_name, 55 std::string* feature_type, 56 std::string* feature_name); 57 58 // Creates a completely clean instance. Configure using RegisterSchema() and 59 // RegisterDependencyProvider before use. 60 ExtensionAPI(); 61 virtual ~ExtensionAPI(); 62 63 // Add a (non-generated) API schema resource. 64 void RegisterSchemaResource(const std::string& api_name, int resource_id); 65 66 // Add a FeatureProvider for APIs. The features are used to specify 67 // dependencies and constraints on the availability of APIs. 68 void RegisterDependencyProvider(const std::string& name, 69 const FeatureProvider* provider); 70 71 // Returns true if the API feature |api| and all of its dependencies are 72 // available in |context|. 73 // 74 // Depending on the configuration of |api| (in _api_features.json), either 75 // |extension| or |url| (or both) may determine its availability, but this is 76 // up to the configuration of the individual feature. 77 Feature::Availability IsAvailable(const Feature& api, 78 const Extension* extension, 79 Feature::Context context, 80 const GURL& url); 81 // Same as the previous overload, but takes a feature name instead of an 82 // object. |api_full_name| can be either a namespace name (like "bookmarks") 83 // or a member name (like "bookmarks.create"). 84 Feature::Availability IsAvailable(const std::string& api_full_name, 85 const Extension* extension, 86 Feature::Context context, 87 const GURL& url); 88 89 // Determines whether an API, or any parts of that API, are available in 90 // |context|. 91 bool IsAnyFeatureAvailableToContext(const Feature& api, 92 const Extension* extension, 93 Feature::Context context, 94 const GURL& url); 95 96 // Returns true if |name| is a privileged API path. Privileged paths can only 97 // be called from extension code which is running in its own designated 98 // extension process. They cannot be called from extension code running in 99 // content scripts, or other low-privileged contexts. 100 bool IsPrivileged(const std::string& name); 101 102 // Gets the schema for the extension API with namespace |full_name|. 103 // Ownership remains with this object. 104 const base::DictionaryValue* GetSchema(const std::string& full_name); 105 106 // Splits a full name from the extension API into its API and child name 107 // parts. Some examples: 108 // 109 // "bookmarks.create" -> ("bookmarks", "create") 110 // "experimental.input.ui.cursorUp" -> ("experimental.input.ui", "cursorUp") 111 // "storage.sync.set" -> ("storage", "sync.get") 112 // "<unknown-api>.monkey" -> ("", "") 113 // 114 // The |child_name| parameter can be be NULL if you don't need that part. 115 std::string GetAPINameFromFullName(const std::string& full_name, 116 std::string* child_name); 117 118 private: 119 FRIEND_TEST_ALL_PREFIXES(ExtensionAPITest, DefaultConfigurationFeatures); 120 FRIEND_TEST_ALL_PREFIXES(ExtensionAPITest, TypesHaveNamespace); 121 friend struct DefaultSingletonTraits<ExtensionAPI>; 122 123 void InitDefaultConfiguration(); 124 125 bool default_configuration_initialized_; 126 127 // Gets a feature from any dependency provider registered with ExtensionAPI. 128 // Returns NULL if the feature could not be found. 129 Feature* GetFeatureDependency(const std::string& dependency_name); 130 131 // Loads a schema. 132 void LoadSchema(const std::string& name, const base::StringPiece& schema); 133 134 // Map from each API that hasn't been loaded yet to the schema which defines 135 // it. Note that there may be multiple APIs per schema. 136 typedef std::map<std::string, int> UnloadedSchemaMap; 137 UnloadedSchemaMap unloaded_schemas_; 138 139 // Schemas for each namespace. 140 typedef std::map<std::string, linked_ptr<const base::DictionaryValue> > 141 SchemaMap; 142 SchemaMap schemas_; 143 144 // FeatureProviders used for resolving dependencies. 145 typedef std::map<std::string, const FeatureProvider*> FeatureProviderMap; 146 FeatureProviderMap dependency_providers_; 147 148 DISALLOW_COPY_AND_ASSIGN(ExtensionAPI); 149 }; 150 151 } // namespace extensions 152 153 #endif // EXTENSIONS_COMMON_EXTENSION_API_H_ 154
