1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
content / browser / webui / web_ui_data_source_impl.h [blame]
// Copyright 2012 The Chromium Authors
// 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 <stdint.h>
#include <map>
#include <string>
#include <string_view>
#include "base/containers/flat_map.h"
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/values.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"
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 URLDataSourceImpl,
public WebUIDataSource {
public:
WebUIDataSourceImpl(const WebUIDataSourceImpl&) = delete;
WebUIDataSourceImpl& operator=(const WebUIDataSourceImpl&) = delete;
// WebUIDataSource:
void AddString(std::string_view name, std::u16string_view value) override;
void AddString(std::string_view name, std::string_view value) override;
void AddLocalizedString(std::string_view name, int ids) override;
void AddLocalizedStrings(
base::span<const webui::LocalizedString> strings) override;
void AddLocalizedStrings(const base::Value::Dict& localized_strings) override;
void AddBoolean(std::string_view name, bool value) override;
void AddInteger(std::string_view name, int32_t value) override;
void AddDouble(std::string_view name, double value) override;
void UseStringsJs() override;
void AddResourcePath(std::string_view path, int resource_id) override;
void AddResourcePaths(base::span<const webui::ResourcePath> paths) override;
void SetDefaultResource(int resource_id) override;
void SetRequestFilter(const WebUIDataSource::ShouldHandleRequestCallback&
should_handle_request_callback,
const WebUIDataSource::HandleRequestCallback&
handle_request_callback) override;
void OverrideContentSecurityPolicy(network::mojom::CSPDirectiveName directive,
const std::string& value) override;
void OverrideCrossOriginOpenerPolicy(const std::string& value) override;
void OverrideCrossOriginEmbedderPolicy(const std::string& value) override;
void OverrideCrossOriginResourcePolicy(const std::string& value) override;
void DisableTrustedTypesCSP() override;
void DisableDenyXFrameOptions() override;
void EnableReplaceI18nInJS() override;
std::string GetSource() override;
std::string GetScheme() override;
void SetSupportedScheme(std::string_view scheme) override;
// Add the locale to the load time data defaults. May be called repeatedly.
void EnsureLoadTimeDataDefaultsAdded();
bool IsWebUIDataSourceImpl() const override;
void AddFrameAncestor(const GURL& frame_ancestor) override;
// URL path to resource ID (Grit IDR) map.
const std::map<std::string, int>& path_to_idr_map() const {
return path_to_idr_map_;
}
protected:
explicit WebUIDataSourceImpl(const std::string& source_name);
~WebUIDataSourceImpl() override;
// Completes a request by sending our dictionary of localized strings.
void SendLocalizedStringsAsJSON(URLDataSource::GotDataCallback callback,
bool from_js_module);
// Protected for testing.
virtual const base::Value::Dict* GetLocalizedStrings() const;
// Protected for testing.
int URLToIdrOrDefault(const GURL& url) const;
private:
class InternalDataSource;
friend class InternalDataSource;
friend class URLDataManagerBackend;
friend class URLDataManagerBackendTest;
friend class WebUIDataSource;
friend class WebUIDataSourceTest;
friend class WebUIImplTest;
// Methods that match URLDataSource which are called by
// InternalDataSource.
std::string GetMimeType(const GURL& url) const;
void StartDataRequest(const GURL& url,
const WebContents::Getter& wc_getter,
URLDataSource::GotDataCallback callback);
// Note: this must be called before StartDataRequest() to have an effect.
void disable_load_time_data_defaults_for_testing() {
add_load_time_data_defaults_ = false;
}
bool ShouldReplaceI18nInJS() const;
// 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_;
bool use_strings_js_ = false;
std::map<std::string, int> path_to_idr_map_;
// The replacements are initialized in the main thread and then used in the
// IO thread. The map is safe to read from multiple threads as long as no
// futher changes are made to it after initialization.
ui::TemplateReplacements replacements_;
// The |replacements_| is intended to replace |localized_strings_|.
// TODO(dschuyler): phase out |localized_strings_| in Q1 2017. (Or rename
// to |load_time_flags_| if the usage is reduced to storing flags only).
base::Value::Dict localized_strings_;
WebUIDataSource::HandleRequestCallback filter_callback_;
WebUIDataSource::ShouldHandleRequestCallback should_handle_request_callback_;
base::flat_map<network::mojom::CSPDirectiveName, std::string> csp_overrides_;
std::string coop_value_;
std::string coep_value_;
std::string corp_value_;
bool deny_xframe_options_ = true;
bool add_load_time_data_defaults_ = true;
bool should_replace_i18n_in_js_ = false;
std::set<GURL> frame_ancestors_;
// Supported scheme if not one of the default supported schemes.
std::optional<std::string> supported_scheme_;
};
} // namespace content
#endif // CONTENT_BROWSER_WEBUI_WEB_UI_DATA_SOURCE_IMPL_H_