extensions/common/extension_api.h

   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   void RegisterSchemaResource(const std::string& api_name, int resource_id);
  64
  65   void RegisterDependencyProvider(const std::string& name,
  66                                   FeatureProvider* provider);
  67
  68   // Returns true if the API feature |api| and all of its dependencies are
  69   // available in |context|.
  70   //
  71   // Depending on the configuration of |api| (in _api_features.json), either
  72   // |extension| or |url| (or both) may determine its availability, but this is
  73   // up to the configuration of the individual feature.
  74   Feature::Availability IsAvailable(const Feature& api,
  75                                     const Extension* extension,
  76                                     Feature::Context context,
  77                                     const GURL& url);
  78   // Same as the previous overload, but takes a feature name instead of an
  79   // object. |api_full_name| can be either a namespace name (like "bookmarks")
  80   // or a member name (like "bookmarks.create").
  81   Feature::Availability IsAvailable(const std::string& api_full_name,
  82                                     const Extension* extension,
  83                                     Feature::Context context,
  84                                     const GURL& url);
  85
  86   // Determines whether an API, or any parts of that API, are available in
  87   // |context|.
  88   bool IsAnyFeatureAvailableToContext(const Feature& api,
  89                                       const Extension* extension,
  90                                       Feature::Context context,
  91                                       const GURL& url);
  92
  93   // Returns true if |name| is a privileged API path. Privileged paths can only
  94   // be called from extension code which is running in its own designated
  95   // extension process. They cannot be called from extension code running in
  96   // content scripts, or other low-privileged contexts.
  97   bool IsPrivileged(const std::string& name);
  98
  99   // Gets the schema for the extension API with namespace |full_name|.
 100   // Ownership remains with this object.
 101   const base::DictionaryValue* GetSchema(const std::string& full_name);
 102
 103   // Splits a full name from the extension API into its API and child name
 104   // parts. Some examples:
 105   //
 106   // "bookmarks.create" -> ("bookmarks", "create")
 107   // "experimental.input.ui.cursorUp" -> ("experimental.input.ui", "cursorUp")
 108   // "storage.sync.set" -> ("storage", "sync.get")
 109   // "<unknown-api>.monkey" -> ("", "")
 110   //
 111   // The |child_name| parameter can be be NULL if you don't need that part.
 112   std::string GetAPINameFromFullName(const std::string& full_name,
 113                                      std::string* child_name);
 114
 115  private:
 116   FRIEND_TEST_ALL_PREFIXES(ExtensionAPITest, DefaultConfigurationFeatures);
 117   FRIEND_TEST_ALL_PREFIXES(ExtensionAPITest, TypesHaveNamespace);
 118   friend struct DefaultSingletonTraits<ExtensionAPI>;
 119
 120   void InitDefaultConfiguration();
 121
 122   bool default_configuration_initialized_;
 123
 124   // Gets a feature from any dependency provider registered with ExtensionAPI.
 125   // Returns NULL if the feature could not be found.
 126   Feature* GetFeatureDependency(const std::string& dependency_name);
 127
 128   // Loads a schema.
 129   void LoadSchema(const std::string& name, const base::StringPiece& schema);
 130
 131   // Map from each API that hasn't been loaded yet to the schema which defines
 132   // it. Note that there may be multiple APIs per schema.
 133   typedef std::map<std::string, int> UnloadedSchemaMap;
 134   UnloadedSchemaMap unloaded_schemas_;
 135
 136   // Schemas for each namespace.
 137   typedef std::map<std::string, linked_ptr<const base::DictionaryValue> >
 138         SchemaMap;
 139   SchemaMap schemas_;
 140
 141   // FeatureProviders used for resolving dependencies.
 142   typedef std::map<std::string, FeatureProvider*> FeatureProviderMap;
 143   FeatureProviderMap dependency_providers_;
 144
 145   DISALLOW_COPY_AND_ASSIGN(ExtensionAPI);
 146 };
 147
 148 } // namespace extensions
 149
 150 #endif  // EXTENSIONS_COMMON_EXTENSION_API_H_