third_party/blink/renderer/modules/keyboard/keyboard_layout.cc

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "third_party/blink/renderer/modules/keyboard/keyboard_layout.h"

#include "third_party/blink/public/common/browser_interface_broker_proxy.h"
#include "third_party/blink/public/common/privacy_budget/identifiability_metric_builder.h"
#include "third_party/blink/public/common/privacy_budget/identifiability_study_settings.h"
#include "third_party/blink/public/common/privacy_budget/identifiable_surface.h"
#include "third_party/blink/public/common/privacy_budget/identifiable_token_builder.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/script_promise_resolver.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_throw_dom_exception.h"
#include "third_party/blink/renderer/core/dom/dom_exception.h"
#include "third_party/blink/renderer/core/execution_context/execution_context.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/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/privacy_budget/identifiability_digest_helpers.h"
#include "third_party/blink/renderer/platform/wtf/functional.h"

namespace blink {

namespace {

constexpr char kKeyboardMapFrameDetachedErrorMsg[] =
    "Current frame is detached.";

constexpr char kFeaturePolicyBlocked[] =
    "getLayoutMap() must be called from a top-level browsing context or "
    "allowed by the permission policy.";

constexpr char kKeyboardMapRequestFailedErrorMsg[] =
    "getLayoutMap() request could not be completed.";

constexpr IdentifiableSurface kGetKeyboardLayoutMapSurface =
    IdentifiableSurface::FromTypeAndToken(
        IdentifiableSurface::Type::kWebFeature,
        WebFeature::kKeyboardApiGetLayoutMap);

IdentifiableToken ComputeLayoutValue(
    const WTF::HashMap<WTF::String, WTF::String>& layout_map) {
  IdentifiableTokenBuilder builder;
  for (const auto& kv : layout_map) {
    builder.AddToken(IdentifiabilityBenignStringToken(kv.key));
    builder.AddToken(IdentifiabilityBenignStringToken(kv.value));
  }
  return builder.GetToken();
}

void RecordGetLayoutMapResult(ExecutionContext* context,
                              IdentifiableToken value) {
  if (!context)
    return;

  IdentifiabilityMetricBuilder(context->UkmSourceID())
      .Add(kGetKeyboardLayoutMapSurface, value)
      .Record(context->UkmRecorder());
}

}  // namespace

KeyboardLayout::KeyboardLayout(ExecutionContext* context)
    : ExecutionContextClient(context), service_(context) {}

ScriptPromiseTyped<KeyboardLayoutMap> KeyboardLayout::GetKeyboardLayoutMap(
    ScriptState* script_state,
    ExceptionState& exception_state) {
  DCHECK(script_state);

  if (script_promise_resolver_) {
    return script_promise_resolver_->Promise();
  }

  if (!IsLocalFrameAttached()) {
    exception_state.ThrowDOMException(DOMExceptionCode::kInvalidStateError,
                                      kKeyboardMapFrameDetachedErrorMsg);
    return ScriptPromiseTyped<KeyboardLayoutMap>();
  }

  if (!EnsureServiceConnected()) {
    if (IdentifiabilityStudySettings::Get()->ShouldSampleSurface(
            kGetKeyboardLayoutMapSurface)) {
      RecordGetLayoutMapResult(ExecutionContext::From(script_state),
                               IdentifiableToken());
    }

    exception_state.ThrowDOMException(DOMExceptionCode::kInvalidStateError,
                                      kKeyboardMapRequestFailedErrorMsg);
    return ScriptPromiseTyped<KeyboardLayoutMap>();
  }

  script_promise_resolver_ =
      MakeGarbageCollected<ScriptPromiseResolverTyped<KeyboardLayoutMap>>(
          script_state, exception_state.GetContext());
  service_->GetKeyboardLayoutMap(
      script_promise_resolver_->WrapCallbackInScriptScope(WTF::BindOnce(
          &KeyboardLayout::GotKeyboardLayoutMap, WrapPersistent(this))));
  return script_promise_resolver_->Promise();
}

bool KeyboardLayout::IsLocalFrameAttached() {
  return DomWindow();
}

bool KeyboardLayout::EnsureServiceConnected() {
  if (!service_.is_bound()) {
    if (!DomWindow())
      return false;
    DomWindow()->GetBrowserInterfaceBroker().GetInterface(
        service_.BindNewPipeAndPassReceiver(
            DomWindow()->GetTaskRunner(TaskType::kMiscPlatformAPI)));
    DCHECK(service_.is_bound());
  }
  return true;
}

void KeyboardLayout::GotKeyboardLayoutMap(
    ScriptPromiseResolverTyped<KeyboardLayoutMap>* resolver,
    mojom::blink::GetKeyboardLayoutMapResultPtr result) {
  DCHECK(script_promise_resolver_);

  bool instrumentation_on =
      IdentifiabilityStudySettings::Get()->ShouldSampleSurface(
          kGetKeyboardLayoutMapSurface);

  switch (result->status) {
    case mojom::blink::GetKeyboardLayoutMapStatus::kSuccess:
      if (instrumentation_on) {
        RecordGetLayoutMapResult(GetExecutionContext(),
                                 ComputeLayoutValue(result->layout_map));
      }
      resolver->Resolve(
          MakeGarbageCollected<KeyboardLayoutMap>(result->layout_map));
      break;
    case mojom::blink::GetKeyboardLayoutMapStatus::kFail:
      if (instrumentation_on)
        RecordGetLayoutMapResult(GetExecutionContext(), IdentifiableToken());

      resolver->Reject(V8ThrowDOMException::CreateOrDie(
          resolver->GetScriptState()->GetIsolate(),
          DOMExceptionCode::kInvalidStateError,
          kKeyboardMapRequestFailedErrorMsg));
      break;
    case mojom::blink::GetKeyboardLayoutMapStatus::kDenied:
      resolver->Reject(V8ThrowDOMException::CreateOrDie(
          resolver->GetScriptState()->GetIsolate(),
          DOMExceptionCode::kSecurityError, kFeaturePolicyBlocked));
      break;
  }

  script_promise_resolver_ = nullptr;
}

void KeyboardLayout::Trace(Visitor* visitor) const {
  visitor->Trace(script_promise_resolver_);
  visitor->Trace(service_);
  ExecutionContextClient::Trace(visitor);
}

}  // namespace blink