blob: 53cbc736cc9db4554c1457bdac49740cba635b47 [file] [log] [blame]
// Copyright (c) 2012 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.
#ifndef CONTENT_BROWSER_WEBUI_WEB_UI_DATA_SOURCE_IMPL_H_
#define CONTENT_BROWSER_WEBUI_WEB_UI_DATA_SOURCE_IMPL_H_
#include <map>
#include <string>
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/values.h"
#include "content/browser/webui/url_data_manager.h"
#include "content/browser/webui/url_data_source_impl.h"
#include "content/common/content_export.h"
#include "content/public/browser/url_data_source.h"
#include "content/public/browser/web_ui_data_source.h"
#include "ui/base/template_expressions.h"
namespace content {
// A data source that can help with implementing the common operations
// needed by the chrome WEBUI settings/history/downloads pages.
class CONTENT_EXPORT WebUIDataSourceImpl
: public NON_EXPORTED_BASE(URLDataSourceImpl),
public NON_EXPORTED_BASE(WebUIDataSource) {
public:
// WebUIDataSource implementation:
void AddString(const std::string& name, const base::string16& value) override;
void AddString(const std::string& name, const std::string& value) override;
void AddLocalizedString(const std::string& name, int ids) override;
void AddLocalizedStrings(
const base::DictionaryValue& localized_strings) override;
void AddBoolean(const std::string& name, bool value) override;
void SetJsonPath(const std::string& path) override;
void AddResourcePath(const std::string& path, int resource_id) override;
void SetDefaultResource(int resource_id) override;
void SetRequestFilter(
const WebUIDataSource::HandleRequestCallback& callback) override;
void DisableReplaceExistingSource() override;
void DisableContentSecurityPolicy() override;
void OverrideContentSecurityPolicyObjectSrc(const std::string& data) override;
void OverrideContentSecurityPolicyFrameSrc(const std::string& data) override;
void DisableDenyXFrameOptions() override;
protected:
~WebUIDataSourceImpl() override;
// Completes a request by sending our dictionary of localized strings.
void SendLocalizedStringsAsJSON(
const URLDataSource::GotDataCallback& callback);
private:
class InternalDataSource;
friend class InternalDataSource;
friend class WebUIDataSource;
friend class WebUIDataSourceTest;
explicit WebUIDataSourceImpl(const std::string& source_name);
// Methods that match URLDataSource which are called by
// InternalDataSource.
std::string GetSource() const;
std::string GetMimeType(const std::string& path) const;
void StartDataRequest(
const std::string& path,
int render_process_id,
int render_frame_id,
const URLDataSource::GotDataCallback& callback);
void disable_set_font_strings_for_testing() {
disable_set_font_strings_ = true;
}
// The name of this source.
// E.g., for favicons, this could be "favicon", which results in paths for
// specific resources like "favicon/34" getting sent to this source.
std::string source_name_;
int default_resource_;
std::string json_path_;
std::map<std::string, int> path_to_idr_map_;
// The |replacements_| is intended to replace |localized_strings_|.
// TODO(dschuyler): phase out |localized_strings_| in Q1 2016. (Or rename
// to |load_time_flags_| if the usage is reduced to storing flags only).
ui::TemplateReplacements replacements_;
base::DictionaryValue localized_strings_;
WebUIDataSource::HandleRequestCallback filter_callback_;
bool add_csp_;
bool object_src_set_;
std::string object_src_;
bool frame_src_set_;
std::string frame_src_;
bool deny_xframe_options_;
bool disable_set_font_strings_;
bool replace_existing_source_;
DISALLOW_COPY_AND_ASSIGN(WebUIDataSourceImpl);
};
} // namespace content
#endif // CONTENT_BROWSER_WEBUI_WEB_UI_DATA_SOURCE_IMPL_H_