third_party/WebKit/Source/modules/vibration/NavigatorVibration.cpp

/*
 *  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 "modules/vibration/NavigatorVibration.h"

#include "core/dom/Document.h"
#include "core/frame/Deprecation.h"
#include "core/frame/FrameConsole.h"
#include "core/frame/LocalDOMWindow.h"
#include "core/frame/LocalFrame.h"
#include "core/frame/Navigator.h"
#include "core/frame/UseCounter.h"
#include "core/inspector/ConsoleMessage.h"
#include "core/page/Page.h"
#include "modules/vibration/VibrationController.h"
#include "platform/Histogram.h"
#include "platform/UserGestureIndicator.h"
#include "platform/feature_policy/FeaturePolicy.h"
#include "public/platform/site_engagement.mojom-blink.h"

namespace blink {

NavigatorVibration::NavigatorVibration(Navigator& navigator)
    : ContextLifecycleObserver(navigator.GetFrame()->GetDocument()) {}

NavigatorVibration::~NavigatorVibration() {}

// static
NavigatorVibration& NavigatorVibration::From(Navigator& navigator) {
  NavigatorVibration* navigator_vibration = static_cast<NavigatorVibration*>(
      Supplement<Navigator>::From(navigator, SupplementName()));
  if (!navigator_vibration) {
    navigator_vibration = new NavigatorVibration(navigator);
    Supplement<Navigator>::ProvideTo(navigator, SupplementName(),
                                     navigator_vibration);
  }
  return *navigator_vibration;
}

// static
const char* NavigatorVibration::SupplementName() {
  return "NavigatorVibration";
}

// static
bool NavigatorVibration::vibrate(Navigator& navigator, unsigned time) {
  VibrationPattern pattern;
  pattern.push_back(time);
  return NavigatorVibration::vibrate(navigator, pattern);
}

// static
bool NavigatorVibration::vibrate(Navigator& navigator,
                                 const VibrationPattern& pattern) {
  LocalFrame* frame = navigator.GetFrame();

  // 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 (!frame)
    return false;
  CollectHistogramMetrics(*frame);

  DCHECK(frame->GetDocument());
  DCHECK(frame->GetPage());

  if (!frame->GetPage()->IsPageVisible())
    return false;

  if (IsSupportedInFeaturePolicy(blink::WebFeaturePolicyFeature::kVibrate) &&
      !frame->IsFeatureEnabled(blink::WebFeaturePolicyFeature::kVibrate)) {
    frame->DomWindow()->PrintErrorMessage(
        "Navigator.vibrate() is not enabled in feature policy for this "
        "frame.");
    return false;
  }

  if (!frame->HasReceivedUserGesture()) {
    String message;
    MessageLevel level = kErrorMessageLevel;
    if (frame->IsCrossOriginSubframe()) {
      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 if (RuntimeEnabledFeatures::vibrateRequiresUserGestureEnabled()) {
      // The actual blocking is targeting M60.
      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.";
    } else {  // Just shows the deprecation message in M59.
      level = kWarningMessageLevel;
      Deprecation::CountDeprecation(frame,
                                    UseCounter::kVibrateWithoutUserGesture);
    }

    if (level == kErrorMessageLevel) {
      frame->DomWindow()->GetFrameConsole()->AddMessage(
          ConsoleMessage::Create(kInterventionMessageSource, level, message));
      return false;
    }
  }

  return NavigatorVibration::From(navigator).Controller(*frame)->Vibrate(
      pattern);
}

// static
void NavigatorVibration::CollectHistogramMetrics(const LocalFrame& frame) {
  NavigatorVibrationType type;
  bool user_gesture = frame.HasReceivedUserGesture();
  UseCounter::Count(&frame, UseCounter::kNavigatorVibrate);
  if (!frame.IsMainFrame()) {
    UseCounter::Count(&frame, UseCounter::kNavigatorVibrateSubFrame);
    if (frame.IsCrossOriginSubframe()) {
      if (user_gesture)
        type = NavigatorVibrationType::kCrossOriginSubFrameWithUserGesture;
      else
        type = NavigatorVibrationType::kCrossOriginSubFrameNoUserGesture;
    } else {
      if (user_gesture)
        type = NavigatorVibrationType::kSameOriginSubFrameWithUserGesture;
      else
        type = NavigatorVibrationType::kSameOriginSubFrameNoUserGesture;
    }
  } else {
    if (user_gesture)
      type = NavigatorVibrationType::kMainFrameWithUserGesture;
    else
      type = NavigatorVibrationType::kMainFrameNoUserGesture;
  }
  DEFINE_STATIC_LOCAL(EnumerationHistogram, navigator_vibrate_histogram,
                      ("Vibration.Context", NavigatorVibrationType::kEnumMax));
  navigator_vibrate_histogram.Count(type);

  switch (frame.GetDocument()->GetEngagementLevel()) {
    case mojom::blink::EngagementLevel::NONE:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementNone);
      break;
    case mojom::blink::EngagementLevel::MINIMAL:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementMinimal);
      break;
    case mojom::blink::EngagementLevel::LOW:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementLow);
      break;
    case mojom::blink::EngagementLevel::MEDIUM:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementMedium);
      break;
    case mojom::blink::EngagementLevel::HIGH:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementHigh);
      break;
    case mojom::blink::EngagementLevel::MAX:
      UseCounter::Count(&frame, UseCounter::kNavigatorVibrateEngagementMax);
      break;
  }
}

VibrationController* NavigatorVibration::Controller(const LocalFrame& frame) {
  if (!controller_)
    controller_ = new VibrationController(*frame.GetDocument());

  return controller_.Get();
}

void NavigatorVibration::ContextDestroyed(ExecutionContext*) {
  if (controller_) {
    controller_->Cancel();
    controller_ = nullptr;
  }
}

DEFINE_TRACE(NavigatorVibration) {
  visitor->Trace(controller_);
  Supplement<Navigator>::Trace(visitor);
  ContextLifecycleObserver::Trace(visitor);
}

}  // namespace blink