chrome/browser/ui/exclusive_access/exclusive_access_manager.h

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

#ifndef CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_MANAGER_H_
#define CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_MANAGER_H_

#include "base/memory/raw_ptr.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_permission_manager.h"
#include "chrome/browser/ui/exclusive_access/fullscreen_controller.h"
#include "chrome/browser/ui/exclusive_access/keyboard_lock_controller.h"
#include "chrome/browser/ui/exclusive_access/pointer_lock_controller.h"
#include "components/input/native_web_keyboard_event.h"
#include "url/origin.h"

class ExclusiveAccessContext;

namespace content {
class WebContents;
}  // namespace content

// This class combines the different exclusive access modes (like fullscreen and
// pointer lock) which are each handled by respective controller. It also
// updates the exit bubble to reflect the combined state.
class ExclusiveAccessManager {
 public:
  explicit ExclusiveAccessManager(
      ExclusiveAccessContext* exclusive_access_context);

  ExclusiveAccessManager(const ExclusiveAccessManager&) = delete;
  ExclusiveAccessManager& operator=(const ExclusiveAccessManager&) = delete;

  ~ExclusiveAccessManager();

  FullscreenController* fullscreen_controller() {
    return &fullscreen_controller_;
  }

  KeyboardLockController* keyboard_lock_controller() {
    return &keyboard_lock_controller_;
  }

  PointerLockController* pointer_lock_controller() {
    return &pointer_lock_controller_;
  }

  ExclusiveAccessContext* context() const { return exclusive_access_context_; }

  ExclusiveAccessBubbleType GetExclusiveAccessExitBubbleType() const;
  // Asks the ExclusiveAccessContext to show, hide, or update the bubble.
  // `first_hide_callback` is called when the bubble is stifled or first hidden.
  // `force_update` will reshow the bubble even if there are no content changes.
  void UpdateBubble(ExclusiveAccessBubbleHideCallback first_hide_callback,
                    bool force_update = false);

  url::Origin GetExclusiveAccessBubbleOrigin() const;

  // Records the keyboard/pointer lock state in a histogram. These should be
  // called when the user enters fullscreen through the Fullscreen API or the
  // browesr UI, respectively.
  void RecordLockStateOnEnteringApiFullscreen() const;
  void RecordLockStateOnEnteringBrowserFullscreen() const;

  // Callbacks ////////////////////////////////////////////////////////////////

  // Called by Browser::TabDeactivated.
  void OnTabDeactivated(content::WebContents* web_contents);

  // Called by Browser::ActiveTabChanged.
  void OnTabDetachedFromView(content::WebContents* web_contents);

  // Called by Browser::TabClosingAt.
  void OnTabClosing(content::WebContents* web_contents);

  // Called by Browser::PreHandleKeyboardEvent.
  bool HandleUserKeyEvent(const input::NativeWebKeyboardEvent& event);

  // Called by Browser::ContentsMouseEvent.
  void OnUserInput();

  // Called by platform ExclusiveAccessExitBubble.
  void ExitExclusiveAccess();

  base::flat_set<raw_ptr<ExclusiveAccessControllerBase>>&
  exclusive_access_controllers_for_test() {
    return exclusive_access_controllers_;
  }

  ExclusiveAccessPermissionManager& permission_manager() {
    return permission_manager_;
  }

  const base::OneShotTimer& esc_key_hold_timer_for_test() {
    return esc_key_hold_timer_;
  }

 private:
  void HandleUserHeldEscape();

  void RecordLockStateOnEnteringFullscreen(const char histogram_name[]) const;

  // The timer starts on Esc key down event and stops on Esc key up event. It
  // invokes `HandleUserHeldEscape()` when the timer is fired.
  base::OneShotTimer esc_key_hold_timer_;

  // The timer starts and stops at the same time as `esc_key_hold_timer_` but is
  // fired after a shorter delay.
  base::OneShotTimer show_exit_bubble_timer_;

  const raw_ptr<ExclusiveAccessContext> exclusive_access_context_;
  FullscreenController fullscreen_controller_;
  KeyboardLockController keyboard_lock_controller_;
  PointerLockController pointer_lock_controller_;
  base::flat_set<raw_ptr<ExclusiveAccessControllerBase>>
      exclusive_access_controllers_;
  ExclusiveAccessPermissionManager permission_manager_;
};

#endif  // CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_MANAGER_H_