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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
// Copyright 2014 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 "content/renderer/pepper/plugin_power_saver_helper.h"
#include "base/metrics/histogram.h"
#include "base/strings/string_number_conversions.h"
#include "content/common/frame_messages.h"
#include "content/public/renderer/document_state.h"
#include "content/public/renderer/navigation_state.h"
#include "content/public/renderer/render_frame.h"
#include "third_party/WebKit/public/web/WebDocument.h"
#include "third_party/WebKit/public/web/WebLocalFrame.h"
#include "third_party/WebKit/public/web/WebPluginParams.h"
#include "third_party/WebKit/public/web/WebView.h"
namespace content {
namespace {
const char kPosterParamName[] = "poster";
// Initial decision of the peripheral content decision.
// These numeric values are used in UMA logs; do not change them.
enum PeripheralHeuristicDecision {
HEURISTIC_DECISION_PERIPHERAL = 0,
HEURISTIC_DECISION_ESSENTIAL_SAME_ORIGIN = 1,
HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_BIG = 2,
HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_WHITELISTED = 3,
HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_TINY = 4,
HEURISTIC_DECISION_NUM_ITEMS
};
const char kPeripheralHeuristicHistogram[] =
"Plugin.PowerSaver.PeripheralHeuristic";
// Maximum dimensions plug-in content may have while still being considered
// peripheral content. These match the sizes used by Safari.
const int kPeripheralContentMaxWidth = 400;
const int kPeripheralContentMaxHeight = 300;
// Plug-in content below this size in height and width is considered "tiny".
// Tiny content is never peripheral, as tiny plug-ins often serve a critical
// purpose, and the user often cannot find and click to unthrottle it.
const int kPeripheralContentTinySize = 5;
void RecordDecisionMetric(PeripheralHeuristicDecision decision) {
UMA_HISTOGRAM_ENUMERATION(kPeripheralHeuristicHistogram, decision,
HEURISTIC_DECISION_NUM_ITEMS);
}
const char kWebPluginParamHeight[] = "height";
const char kWebPluginParamWidth[] = "width";
// Returns true if valid non-negative height and width extracted.
// When this returns false, |width| and |height| are set to undefined values.
bool ExtractDimensions(const blink::WebPluginParams& params,
int* width,
int* height) {
DCHECK_EQ(params.attributeNames.size(), params.attributeValues.size());
DCHECK(width);
DCHECK(height);
bool width_extracted = false;
bool height_extracted = false;
for (size_t i = 0; i < params.attributeNames.size(); ++i) {
if (params.attributeNames[i].utf8() == kWebPluginParamWidth) {
width_extracted =
base::StringToInt(params.attributeValues[i].utf8(), width);
} else if (params.attributeNames[i].utf8() == kWebPluginParamHeight) {
height_extracted =
base::StringToInt(params.attributeValues[i].utf8(), height);
}
}
return width_extracted && height_extracted && *width >= 0 && *height >= 0;
}
GURL GetPluginInstancePosterImage(const blink::WebPluginParams& params,
const GURL& page_base_url) {
DCHECK_EQ(params.attributeNames.size(), params.attributeValues.size());
for (size_t i = 0; i < params.attributeNames.size(); ++i) {
if (params.attributeNames[i] == kPosterParamName) {
std::string poster_value(params.attributeValues[i].utf8());
if (!poster_value.empty())
return page_base_url.Resolve(poster_value);
}
}
return GURL();
}
} // namespace
PluginPowerSaverHelper::PeripheralPlugin::PeripheralPlugin(
const GURL& content_origin,
const base::Closure& unthrottle_callback)
: content_origin(content_origin), unthrottle_callback(unthrottle_callback) {
}
PluginPowerSaverHelper::PeripheralPlugin::~PeripheralPlugin() {
}
PluginPowerSaverHelper::PluginPowerSaverHelper(RenderFrame* render_frame)
: RenderFrameObserver(render_frame) {
}
PluginPowerSaverHelper::~PluginPowerSaverHelper() {
}
void PluginPowerSaverHelper::DidCommitProvisionalLoad(bool is_new_navigation) {
blink::WebFrame* frame = render_frame()->GetWebFrame();
if (frame->parent())
return; // Not a top-level navigation.
DocumentState* document_state =
DocumentState::FromDataSource(frame->dataSource());
NavigationState* navigation_state = document_state->navigation_state();
if (!navigation_state->was_within_same_page())
origin_whitelist_.clear();
}
bool PluginPowerSaverHelper::OnMessageReceived(const IPC::Message& message) {
bool handled = true;
IPC_BEGIN_MESSAGE_MAP(PluginPowerSaverHelper, message)
IPC_MESSAGE_HANDLER(FrameMsg_UpdatePluginContentOriginWhitelist,
OnUpdatePluginContentOriginWhitelist)
IPC_MESSAGE_UNHANDLED(handled = false)
IPC_END_MESSAGE_MAP()
return handled;
}
void PluginPowerSaverHelper::OnUpdatePluginContentOriginWhitelist(
const std::set<GURL>& origin_whitelist) {
origin_whitelist_ = origin_whitelist;
// Check throttled plugin instances to see if any can be unthrottled.
auto it = peripheral_plugins_.begin();
while (it != peripheral_plugins_.end()) {
if (origin_whitelist.count(it->content_origin)) {
it->unthrottle_callback.Run();
it = peripheral_plugins_.erase(it);
} else {
++it;
}
}
}
void PluginPowerSaverHelper::RegisterPeripheralPlugin(
const GURL& content_origin,
const base::Closure& unthrottle_callback) {
peripheral_plugins_.push_back(
PeripheralPlugin(content_origin, unthrottle_callback));
}
bool PluginPowerSaverHelper::ShouldThrottleContent(
const blink::WebPluginParams& params,
const GURL& plugin_frame_url,
GURL* poster_image,
bool* cross_origin_main_content) const {
if (poster_image)
*poster_image = GURL();
if (cross_origin_main_content)
*cross_origin_main_content = false;
GURL content_origin = GURL(params.url).GetOrigin();
int width = 0;
int height = 0;
if (!ExtractDimensions(params, &width, &height))
return false;
// TODO(alexmos): Update this to use the origin of the RemoteFrame when 426512
// is fixed. For now, case 3 in the class level comment doesn't work in
// --site-per-process mode.
blink::WebFrame* main_frame =
render_frame()->GetWebFrame()->view()->mainFrame();
if (main_frame->isWebRemoteFrame()) {
RecordDecisionMetric(HEURISTIC_DECISION_PERIPHERAL);
if (poster_image)
*poster_image = GetPluginInstancePosterImage(params, plugin_frame_url);
return true;
}
// All same-origin plugin content is essential.
GURL main_frame_origin = GURL(main_frame->document().url()).GetOrigin();
if (content_origin == main_frame_origin) {
RecordDecisionMetric(HEURISTIC_DECISION_ESSENTIAL_SAME_ORIGIN);
return false;
}
// Whitelisted plugin origins are also essential.
if (origin_whitelist_.count(content_origin)) {
RecordDecisionMetric(HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_WHITELISTED);
return false;
}
// Never mark tiny content as peripheral.
if (width <= kPeripheralContentTinySize &&
height <= kPeripheralContentTinySize) {
RecordDecisionMetric(HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_TINY);
return false;
}
// Plugin content large in both dimensions are the "main attraction".
if (width >= kPeripheralContentMaxWidth &&
height >= kPeripheralContentMaxHeight) {
RecordDecisionMetric(HEURISTIC_DECISION_ESSENTIAL_CROSS_ORIGIN_BIG);
if (cross_origin_main_content)
*cross_origin_main_content = true;
return false;
}
RecordDecisionMetric(HEURISTIC_DECISION_PERIPHERAL);
if (poster_image)
*poster_image = GetPluginInstancePosterImage(params, plugin_frame_url);
return true;
}
void PluginPowerSaverHelper::WhitelistContentOrigin(
const GURL& content_origin) {
DCHECK_EQ(content_origin.GetOrigin(), content_origin);
if (origin_whitelist_.insert(content_origin).second) {
Send(new FrameHostMsg_PluginContentOriginAllowed(
render_frame()->GetRoutingID(), content_origin));
}
}
} // namespace content
|
