chrome/browser/ui/exclusive_access/exclusive_access_bubble.cc

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

#include "chrome/browser/ui/exclusive_access/exclusive_access_bubble.h"

#include "base/feature_list.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "chrome/app/chrome_command_ids.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_context.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_manager.h"
#include "chrome/browser/ui/exclusive_access/fullscreen_controller.h"
#include "extensions/browser/extension_registry.h"
#include "third_party/blink/public/common/features_generated.h"
#include "ui/display/screen.h"
#include "ui/gfx/geometry/rect.h"

// NOTE(koz): Linux doesn't use the thick shadowed border, so we add padding
// here.
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
const int ExclusiveAccessBubble::kPaddingPx = 8;
#else
const int ExclusiveAccessBubble::kPaddingPx = 15;
#endif
const int ExclusiveAccessBubble::kInitialDelayMs = 3800;
const int ExclusiveAccessBubble::kIdleTimeMs = 2300;
const int ExclusiveAccessBubble::kSnoozeNotificationsTimeMs = 900000;  // 15m.
const int ExclusiveAccessBubble::kPositionCheckHz = 10;
const int ExclusiveAccessBubble::kSlideInRegionHeightPx = 4;
const int ExclusiveAccessBubble::kPopupTopPx = 45;
const int ExclusiveAccessBubble::kSimplifiedPopupTopPx = 45;

ExclusiveAccessBubble::ExclusiveAccessBubble(
    ExclusiveAccessManager* manager,
    const GURL& url,
    ExclusiveAccessBubbleType bubble_type,
    bool notify_download)
    : manager_(manager),
      url_(url),
      bubble_type_(bubble_type),
      notify_download_(notify_download),
      hide_timeout_(
          FROM_HERE,
          base::Milliseconds(kInitialDelayMs),
          base::BindRepeating(&ExclusiveAccessBubble::CheckMousePointerPosition,
                              base::Unretained(this))),
      idle_timeout_(
          FROM_HERE,
          base::Milliseconds(kIdleTimeMs),
          base::BindRepeating(&ExclusiveAccessBubble::CheckMousePointerPosition,
                              base::Unretained(this))),
      suppress_notify_timeout_(
          FROM_HERE,
          base::Milliseconds(kSnoozeNotificationsTimeMs),
          base::BindRepeating(&ExclusiveAccessBubble::CheckMousePointerPosition,
                              base::Unretained(this))),
      mouse_pointer_position_checker_(
          FROM_HERE,
          base::Milliseconds(1000 / kPositionCheckHz),
          base::BindRepeating(&ExclusiveAccessBubble::CheckMousePointerPosition,
                              base::Unretained(this))) {
  DCHECK(notify_download_ || EXCLUSIVE_ACCESS_BUBBLE_TYPE_NONE != bubble_type_);
}

ExclusiveAccessBubble::~ExclusiveAccessBubble() = default;

void ExclusiveAccessBubble::OnUserInput() {
  // We got some user input; reset the idle timer.
  idle_timeout_.Reset();

  // Re-show the exit bubble for cross-display fullscreen where no input was
  // detected yet.
  bool first_input_reshow =
      reshow_on_first_input_ && !has_seen_user_input_ &&
      base::FeatureList::IsEnabled(blink::features::kFullscreenPopupWindows) &&
      bubble_type_ ==
          ExclusiveAccessBubbleType::
              EXCLUSIVE_ACCESS_BUBBLE_TYPE_FULLSCREEN_EXIT_INSTRUCTION;
  reshow_on_first_input_ = false;
  has_seen_user_input_ = true;

  // If the notification suppression timer has elapsed, re-show it.
  if (!suppress_notify_timeout_.IsRunning() || first_input_reshow) {
    ShowAndStartTimers();
    return;
  }

  // The timer has not elapsed, but the user provided some input. Reset the
  // timer. (We only want to re-show the message after a period of inactivity.)
  suppress_notify_timeout_.Reset();
}

void ExclusiveAccessBubble::StartWatchingMousePointer() {
  // Start the initial delay timer and begin watching the pointer.
  ShowAndStartTimers();
  mouse_pointer_position_checker_.Reset();
}

void ExclusiveAccessBubble::StopWatchingMousePointer() {
  hide_timeout_.Stop();
  idle_timeout_.Stop();
  mouse_pointer_position_checker_.Stop();
}

bool ExclusiveAccessBubble::IsWatchingMousePointer() const {
  return mouse_pointer_position_checker_.IsRunning();
}

void ExclusiveAccessBubble::CheckMousePointerPosition() {
  if (!hide_timeout_.IsRunning()) {
    // If no input has been detected yet and the cursor is still on a different
    // display than the bubble, set a flag to re-show the bubble once input is
    // detected.
    if (!has_seen_user_input_ && !reshow_on_first_input_ &&
        bubble_type_ ==
            ExclusiveAccessBubbleType::
                EXCLUSIVE_ACCESS_BUBBLE_TYPE_FULLSCREEN_EXIT_INSTRUCTION) {
      display::Screen* screen = display::Screen::GetScreen();
      reshow_on_first_input_ =
          screen &&
          screen->GetDisplayNearestPoint(screen->GetCursorScreenPoint()) !=
              screen->GetDisplayNearestPoint(GetPopupRect().CenterPoint());
    }
    Hide();
  }
}

std::u16string ExclusiveAccessBubble::GetInstructionText(
    const std::u16string& accelerator) const {
  return exclusive_access_bubble::GetInstructionTextForType(
      bubble_type_, accelerator, notify_download_, notify_overridden_);
}

bool ExclusiveAccessBubble::IsHideTimeoutRunning() const {
  return hide_timeout_.IsRunning();
}

void ExclusiveAccessBubble::ShowAndStartTimers() {
  Show();

  // Do not allow the notification to hide for a few seconds.
  hide_timeout_.Reset();

  // Do not show the notification again until a long time has elapsed.
  suppress_notify_timeout_.Reset();
}