content/public/browser/web_ui_data_source.h

   1 // Copyright (c) 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 CONTENT_PUBLIC_BROWSER_WEB_UI_DATA_SOURCE_H_
   6 #define CONTENT_PUBLIC_BROWSER_WEB_UI_DATA_SOURCE_H_
   7
   8 #include "base/callback.h"
   9 #include "base/strings/string16.h"
  10 #include "content/common/content_export.h"
  11
  12 namespace base {
  13 class DictionaryValue;
  14 class RefCountedMemory;
  15 }
  16
  17 namespace content {
  18 class BrowserContext;
  19
  20 // A data source that can help with implementing the common operations needed by
  21 // WebUI pages.
  22 class WebUIDataSource {
  23  public:
  24   virtual ~WebUIDataSource() {}
  25
  26   CONTENT_EXPORT static WebUIDataSource* Create(const std::string& source_name);
  27
  28   // Adds the necessary resources for mojo bindings returning the
  29   // WebUIDataSource that handles the resources. Callers do not own the return
  30   // value.
  31   CONTENT_EXPORT static WebUIDataSource* AddMojoDataSource(
  32       BrowserContext* browser_context);
  33
  34   // Adds a WebUI data source to |browser_context|.
  35   CONTENT_EXPORT static void Add(BrowserContext* browser_context,
  36                                  WebUIDataSource* source);
  37
  38   // Adds a string keyed to its name to our dictionary.
  39   virtual void AddString(const std::string& name,
  40                          const base::string16& value) = 0;
  41
  42   // Adds a string keyed to its name to our dictionary.
  43   virtual void AddString(const std::string& name, const std::string& value) = 0;
  44
  45   // Adds a localized string with resource |ids| keyed to its name to our
  46   // dictionary.
  47   virtual void AddLocalizedString(const std::string& name, int ids) = 0;
  48
  49   // Add strings from |localized_strings| to our dictionary.
  50   virtual void AddLocalizedStrings(
  51       const base::DictionaryValue& localized_strings) = 0;
  52
  53   // Adds a boolean keyed to its name to our dictionary.
  54   virtual void AddBoolean(const std::string& name, bool value) = 0;
  55
  56   // Sets the path which will return the JSON strings.
  57   virtual void SetJsonPath(const std::string& path) = 0;
  58
  59   // Sets the data source to use a slightly different format for json data. Some
  60   // day this should become the default.
  61   virtual void SetUseJsonJSFormatV2() = 0;
  62
  63   // Adds a mapping between a path name and a resource to return.
  64   virtual void AddResourcePath(const std::string& path, int resource_id) = 0;
  65
  66   // Sets the resource to returned when no other paths match.
  67   virtual void SetDefaultResource(int resource_id) = 0;
  68
  69   // Used as a parameter to GotDataCallback. The caller has to run this callback
  70   // with the result for the path that they filtered, passing ownership of the
  71   // memory.
  72   typedef base::Callback<void(base::RefCountedMemory*)> GotDataCallback;
  73
  74   // Used by SetRequestFilter. The string parameter is the path of the request.
  75   // If the callee doesn't want to handle the data, false is returned. Otherwise
  76   // true is returned and the GotDataCallback parameter is called either then or
  77   // asynchronously with the response.
  78   typedef base::Callback<bool(const std::string&, const GotDataCallback&)>
  79       HandleRequestCallback;
  80
  81   // Allows a caller to add a filter for URL requests.
  82   virtual void SetRequestFilter(const HandleRequestCallback& callback) = 0;
  83
  84   // The following map to methods on URLDataSource. See the documentation there.
  85   // NOTE: it's not acceptable to call DisableContentSecurityPolicy for new
  86   // pages, see URLDataSource::ShouldAddContentSecurityPolicy and talk to
  87   // tsepez.
  88
  89   // Currently only used by embedders for WebUIs with multiple instances.
  90   virtual void DisableReplaceExistingSource() = 0;
  91   virtual void DisableContentSecurityPolicy() = 0;
  92   virtual void OverrideContentSecurityPolicyObjectSrc(
  93       const std::string& data) = 0;
  94   virtual void OverrideContentSecurityPolicyFrameSrc(
  95       const std::string& data) = 0;
  96   virtual void DisableDenyXFrameOptions() = 0;
  97 };
  98
  99 }  // namespace content
 100
 101 #endif  // CONTENT_PUBLIC_BROWSER_WEB_UI_DATA_SOURCE_H_