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