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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
|
/*
* Copyright (C) 2012 Samsung Electronics
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "third_party/blink/renderer/modules/vibration/vibration_controller.h"
#include "third_party/blink/public/platform/browser_interface_broker_proxy.h"
#include "third_party/blink/public/platform/platform.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_union_unsignedlong_unsignedlongsequence.h"
#include "third_party/blink/renderer/core/frame/intervention.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/navigator.h"
#include "third_party/blink/renderer/core/page/page.h"
// Maximum number of entries in a vibration pattern.
const unsigned kVibrationPatternLengthMax = 99;
// Maximum duration of a vibration is 10 seconds.
const unsigned kVibrationDurationMsMax = 10000;
blink::VibrationController::VibrationPattern sanitizeVibrationPatternInternal(
const blink::VibrationController::VibrationPattern& pattern) {
blink::VibrationController::VibrationPattern sanitized = pattern;
wtf_size_t length = sanitized.size();
// If the pattern is too long then truncate it.
if (length > kVibrationPatternLengthMax) {
sanitized.Shrink(kVibrationPatternLengthMax);
length = kVibrationPatternLengthMax;
}
// If any pattern entry is too long then truncate it.
for (wtf_size_t i = 0; i < length; ++i) {
if (sanitized[i] > kVibrationDurationMsMax)
sanitized[i] = kVibrationDurationMsMax;
}
// If the last item in the pattern is a pause then discard it.
if (length && !(length % 2))
sanitized.pop_back();
return sanitized;
}
namespace blink {
// static
VibrationController::VibrationPattern
VibrationController::SanitizeVibrationPattern(
const V8UnionUnsignedLongOrUnsignedLongSequence* input) {
switch (input->GetContentType()) {
case V8UnionUnsignedLongOrUnsignedLongSequence::ContentType::
kUnsignedLong: {
VibrationPattern pattern;
pattern.push_back(input->GetAsUnsignedLong());
return sanitizeVibrationPatternInternal(pattern);
}
case V8UnionUnsignedLongOrUnsignedLongSequence::ContentType::
kUnsignedLongSequence:
return sanitizeVibrationPatternInternal(
input->GetAsUnsignedLongSequence());
}
NOTREACHED();
}
// static
VibrationController& VibrationController::From(Navigator& navigator) {
VibrationController* vibration_controller =
Supplement<Navigator>::From<VibrationController>(navigator);
if (!vibration_controller) {
vibration_controller = MakeGarbageCollected<VibrationController>(navigator);
ProvideTo(navigator, vibration_controller);
}
return *vibration_controller;
}
// static
const char VibrationController::kSupplementName[] = "VibrationController";
// static
bool VibrationController::vibrate(Navigator& navigator, unsigned time) {
VibrationPattern pattern;
pattern.push_back(time);
return vibrate(navigator, pattern);
}
// static
bool VibrationController::vibrate(Navigator& navigator,
const VibrationPattern& pattern) {
// There will be no frame if the window has been closed, but a JavaScript
// reference to |window| or |navigator| was retained in another window.
if (!navigator.DomWindow())
return false;
return From(navigator).Vibrate(pattern);
}
VibrationController::VibrationController(Navigator& navigator)
: Supplement<Navigator>(navigator),
ExecutionContextLifecycleObserver(navigator.DomWindow()),
PageVisibilityObserver(DomWindow()->GetFrame()->GetPage()),
vibration_manager_(DomWindow()),
timer_do_vibrate_(DomWindow()->GetTaskRunner(TaskType::kMiscPlatformAPI),
this,
&VibrationController::DoVibrate),
is_running_(false),
is_calling_cancel_(false),
is_calling_vibrate_(false) {
DomWindow()->GetBrowserInterfaceBroker().GetInterface(
vibration_manager_.BindNewPipeAndPassReceiver(
DomWindow()->GetTaskRunner(TaskType::kMiscPlatformAPI)));
}
VibrationController::~VibrationController() = default;
bool VibrationController::Vibrate(const VibrationPattern& pattern) {
UseCounter::Count(DomWindow(), WebFeature::kNavigatorVibrate);
LocalFrame* frame = DomWindow()->GetFrame();
if (frame->IsInFencedFrameTree()) {
Intervention::GenerateReport(
frame, "NavigatorVibrate",
"Blocked call to navigator.vibrate inside a fenced frame.");
return false;
}
if (!frame->GetPage()->IsPageVisible())
return false;
if (!frame->HasStickyUserActivation()) {
String message;
if (frame->IsCrossOriginToNearestMainFrame()) {
message =
"Blocked call to navigator.vibrate inside a cross-origin "
"iframe because the frame has never been activated by the user: "
"https://www.chromestatus.com/feature/5682658461876224.";
} else {
message =
"Blocked call to navigator.vibrate because user hasn't tapped "
"on the frame or any embedded frame yet: "
"https://www.chromestatus.com/feature/5644273861001216.";
}
Intervention::GenerateReport(frame, "NavigatorVibrate", message);
return false;
}
// Cancel clears the stored pattern and cancels any ongoing vibration.
Cancel();
pattern_ = sanitizeVibrationPatternInternal(pattern);
if (!pattern_.size())
return true;
if (pattern_.size() == 1 && !pattern_[0]) {
pattern_.clear();
return true;
}
is_running_ = true;
// This may be a bit racy with |didCancel| being called as a mojo callback,
// it also starts the timer. This is not a problem as calling |startOneShot|
// repeatedly will just update the time at which to run |doVibrate|, it will
// not be called more than once.
timer_do_vibrate_.StartOneShot(base::TimeDelta(), FROM_HERE);
return true;
}
void VibrationController::DoVibrate(TimerBase* timer) {
DCHECK(timer == &timer_do_vibrate_);
if (pattern_.empty())
is_running_ = false;
if (!is_running_ || is_calling_cancel_ || is_calling_vibrate_ ||
!GetExecutionContext() || !GetPage()->IsPageVisible())
return;
if (vibration_manager_.is_bound()) {
is_calling_vibrate_ = true;
vibration_manager_->Vibrate(
pattern_[0],
WTF::BindOnce(&VibrationController::DidVibrate, WrapPersistent(this)));
}
}
void VibrationController::DidVibrate() {
is_calling_vibrate_ = false;
// If the pattern is empty here, it was probably cleared by a fresh call to
// |vibrate| while the mojo call was in flight.
if (pattern_.empty())
return;
// Use the current vibration entry of the pattern as the initial interval.
unsigned interval = pattern_[0];
pattern_.EraseAt(0);
// If there is another entry it is for a pause.
if (!pattern_.empty()) {
interval += pattern_[0];
pattern_.EraseAt(0);
}
timer_do_vibrate_.StartOneShot(base::Milliseconds(interval), FROM_HERE);
}
void VibrationController::Cancel() {
pattern_.clear();
timer_do_vibrate_.Stop();
if (is_running_ && !is_calling_cancel_ && vibration_manager_.is_bound()) {
is_calling_cancel_ = true;
vibration_manager_->Cancel(
WTF::BindOnce(&VibrationController::DidCancel, WrapPersistent(this)));
}
is_running_ = false;
}
void VibrationController::DidCancel() {
is_calling_cancel_ = false;
// A new vibration pattern may have been set while the mojo call for
// |cancel| was in flight, so kick the timer to let |doVibrate| process the
// pattern.
timer_do_vibrate_.StartOneShot(base::TimeDelta(), FROM_HERE);
}
void VibrationController::ContextDestroyed() {
Cancel();
// If the document context was destroyed, never call the mojo service again.
// TODO(crbug.com/1116948): Remove this line once vibration_manager_ switches
// to kForceWithContextObserver.
vibration_manager_.reset();
}
void VibrationController::PageVisibilityChanged() {
if (!GetPage()->IsPageVisible())
Cancel();
}
void VibrationController::Trace(Visitor* visitor) const {
Supplement<Navigator>::Trace(visitor);
ExecutionContextLifecycleObserver::Trace(visitor);
PageVisibilityObserver::Trace(visitor);
visitor->Trace(vibration_manager_);
visitor->Trace(timer_do_vibrate_);
}
} // namespace blink
|