blob: 5e0a2deb5680a34b4aa6e91bf182c97cb49a65e1 [file] [log] [blame]
// Copyright (c) 2013 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.
#include "base/callback.h"
#include "base/strings/string16.h"
#include "content/common/content_export.h"
namespace base {
class DictionaryValue;
class RefCountedMemory;
namespace content {
class BrowserContext;
// A data source that can help with implementing the common operations needed by
// WebUI pages.
class WebUIDataSource {
virtual ~WebUIDataSource() {}
CONTENT_EXPORT static WebUIDataSource* Create(const std::string& source_name);
// Adds the necessary resources for mojo bindings returning the
// WebUIDataSource that handles the resources. Callers do not own the return
// value.
CONTENT_EXPORT static WebUIDataSource* AddMojoDataSource(
BrowserContext* browser_context);
// Adds a WebUI data source to |browser_context|.
CONTENT_EXPORT static void Add(BrowserContext* browser_context,
WebUIDataSource* source);
// Adds a string keyed to its name to our dictionary.
virtual void AddString(const std::string& name,
const base::string16& value) = 0;
// Adds a string keyed to its name to our dictionary.
virtual void AddString(const std::string& name, const std::string& value) = 0;
// Adds a localized string with resource |ids| keyed to its name to our
// dictionary.
virtual void AddLocalizedString(const std::string& name, int ids) = 0;
// Add strings from |localized_strings| to our dictionary.
virtual void AddLocalizedStrings(
const base::DictionaryValue& localized_strings) = 0;
// Adds a boolean keyed to its name to our dictionary.
virtual void AddBoolean(const std::string& name, bool value) = 0;
// Sets the path which will return the JSON strings.
virtual void SetJsonPath(const std::string& path) = 0;
// Adds a mapping between a path name and a resource to return.
virtual void AddResourcePath(const std::string& path, int resource_id) = 0;
// Sets the resource to returned when no other paths match.
virtual void SetDefaultResource(int resource_id) = 0;
// Used as a parameter to GotDataCallback. The caller has to run this callback
// with the result for the path that they filtered, passing ownership of the
// memory.
typedef base::Callback<void(base::RefCountedMemory*)> GotDataCallback;
// Used by SetRequestFilter. The string parameter is the path of the request.
// If the callee doesn't want to handle the data, false is returned. Otherwise
// true is returned and the GotDataCallback parameter is called either then or
// asynchronously with the response.
typedef base::Callback<bool(const std::string&, const GotDataCallback&)>
// Allows a caller to add a filter for URL requests.
virtual void SetRequestFilter(const HandleRequestCallback& callback) = 0;
// The following map to methods on URLDataSource. See the documentation there.
// NOTE: it's not acceptable to call DisableContentSecurityPolicy for new
// pages, see URLDataSource::ShouldAddContentSecurityPolicy and talk to
// tsepez.
// Currently only used by embedders for WebUIs with multiple instances.
virtual void DisableReplaceExistingSource() = 0;
virtual void DisableContentSecurityPolicy() = 0;
virtual void OverrideContentSecurityPolicyObjectSrc(
const std::string& data) = 0;
virtual void OverrideContentSecurityPolicyFrameSrc(
const std::string& data) = 0;
virtual void DisableDenyXFrameOptions() = 0;
} // namespace content