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

// Copyright 2018 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 "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/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/heap.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 kKeyboardMapChildFrameErrorMsg[] =
    "getLayoutMap() must be called from a top-level browsing context.";

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())
      .Set(kGetKeyboardLayoutMapSurface, value)
      .Record(context->UkmRecorder());
}

}  // namespace

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

ScriptPromise 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 ScriptPromise();
  }

  if (!CalledFromSupportedContext(ExecutionContext::From(script_state))) {
    exception_state.ThrowDOMException(DOMExceptionCode::kInvalidStateError,
                                      kKeyboardMapChildFrameErrorMsg);
    return ScriptPromise();
  }

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

    exception_state.ThrowDOMException(DOMExceptionCode::kInvalidStateError,
                                      kKeyboardMapRequestFailedErrorMsg);
    return ScriptPromise();
  }

  script_promise_resolver_ =
      MakeGarbageCollected<ScriptPromiseResolver>(script_state);
  service_->GetKeyboardLayoutMap(
      WTF::Bind(&KeyboardLayout::GotKeyboardLayoutMap, WrapPersistent(this),
                WrapPersistent(script_promise_resolver_.Get())));
  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;
}

bool KeyboardLayout::CalledFromSupportedContext(ExecutionContext* context) {
  DCHECK(context);
  // This API is only accessible from a top level, secure browsing context.
  return DomWindow() && DomWindow()->GetFrame()->IsMainFrame() &&
         context->IsSecureContext();
}

void KeyboardLayout::GotKeyboardLayoutMap(
    ScriptPromiseResolver* resolver,
    mojom::blink::GetKeyboardLayoutMapResultPtr result) {
  DCHECK(script_promise_resolver_);

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

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

      script_promise_resolver_->Reject(MakeGarbageCollected<DOMException>(
          DOMExceptionCode::kInvalidStateError,
          kKeyboardMapRequestFailedErrorMsg));
      break;
  }

  script_promise_resolver_ = nullptr;
}

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

}  // namespace blink