chrome/browser/ui/window_sizer/window_sizer.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/window_sizer/window_sizer.h"

#include <algorithm>
#include <utility>

#include "base/command_line.h"
#include "base/functional/function_ref.h"
#include "base/memory/raw_ptr.h"
#include "build/build_config.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_window.h"
#include "chrome/browser/ui/browser_window_state.h"
#include "chrome/browser/ui/web_applications/app_browser_controller.h"
#include "chrome/common/chrome_switches.h"
#include "components/prefs/pref_service.h"
#include "ui/base/mojom/window_show_state.mojom.h"
#include "ui/base/ui_base_switches.h"
#include "ui/display/display.h"
#include "ui/display/screen.h"

#if BUILDFLAG(IS_CHROMEOS)
#include "chrome/browser/ui/window_sizer/window_sizer_chromeos.h"
#endif

namespace {

// Minimum height of the visible part of a window.
const int kMinVisibleHeight = 30;
// Minimum width of the visible part of a window.
const int kMinVisibleWidth = 30;

#if BUILDFLAG(IS_CHROMEOS)
// This specifies the minimum percentage of a window's dimension (either width
// or height) that must remain visible with the display area.
constexpr float kMinVisibleRatio = 0.3f;
#endif

BrowserWindow* FindMostRecentBrowserWindow(
    base::FunctionRef<bool(Browser*)> matcher) {
  for (Browser* last_active :
       BrowserList::GetInstance()->OrderedByActivation()) {
    if (last_active && matcher(last_active)) {
      DCHECK(last_active->window());
      return last_active->window();
    }
  }
  return nullptr;
}

///////////////////////////////////////////////////////////////////////////////
// An implementation of WindowSizer::StateProvider that gets the last active
// and persistent state from the browser window and the user's profile.
class DefaultStateProvider : public WindowSizer::StateProvider {
 public:
  explicit DefaultStateProvider(const Browser* browser) : browser_(browser) {}

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

  // Overridden from WindowSizer::StateProvider:
  bool GetPersistentState(
      gfx::Rect* bounds,
      gfx::Rect* work_area,
      ui::mojom::WindowShowState* show_state) const override {
    DCHECK(bounds);
    DCHECK(show_state);

    if (!browser_ || !browser_->profile()->GetPrefs()) {
      return false;
    }

    const base::Value::Dict* pref =
        chrome::GetWindowPlacementDictionaryReadOnly(
            chrome::GetWindowName(browser_), browser_->profile()->GetPrefs());

    std::optional<gfx::Rect> pref_bounds = RectFromPrefixedPref(pref, "");
    std::optional<gfx::Rect> pref_area =
        RectFromPrefixedPref(pref, "work_area_");
    std::optional<bool> maximized =
        pref ? pref->FindBool("maximized") : std::nullopt;

    if (!pref_bounds || !maximized) {
      return false;
    }

    *bounds = pref_bounds.value();
    if (pref_area) {
      *work_area = pref_area.value();
    }
    if (*show_state == ui::mojom::WindowShowState::kDefault &&
        maximized.value()) {
      *show_state = ui::mojom::WindowShowState::kMaximized;
    }

    return true;
  }

  bool GetLastActiveWindowState(
      gfx::Rect* bounds,
      ui::mojom::WindowShowState* show_state) const override {
    DCHECK(show_state);
    // Legacy Applications and Devtools are always restored with the same
    // position.
    if (browser_ && !web_app::AppBrowserController::IsWebApp(browser_) &&
        (browser_->is_type_app() || browser_->is_type_app_popup() ||
         browser_->is_type_devtools())) {
      return false;
    }

    // If a reference browser is set, use its window. Otherwise find last
    // active. Depending on the type of browser being created, different logic
    // determines if a particular browser can be a reference browser.
    BrowserWindow* window = nullptr;
    // Window may be null if browser is just starting up.
    if (browser_ && browser_->window()) {
      window = browser_->window();
    } else if (web_app::AppBrowserController::IsWebApp(browser_)) {
      window = FindMostRecentBrowserWindow(
          [profile = browser_->profile(),
           app_id = browser_->app_controller()->app_id(),
           display = display::Screen::Get()->GetDisplayForNewWindows()](
              Browser* browser) {
            if (browser->profile() != profile) {
              return false;
            }
            if (!web_app::AppBrowserController::IsForWebApp(browser, app_id)) {
              return false;
            }
#if BUILDFLAG(IS_CHROMEOS)
            if (display::Screen::Get()->GetDisplayNearestWindow(
                    browser->window()->GetNativeWindow()) != display) {
              return false;
            }
#endif
            if (!browser->window()->IsOnCurrentWorkspace())
              return false;
            return true;
          });
    } else {
      window = FindMostRecentBrowserWindow(
          [](Browser* browser) { return browser->is_type_normal(); });
    }

    if (window) {
      *bounds = window->GetRestoredBounds();

      // On Mac GetRestoredBounds already returns the maximized bounds for
      // maximized windows. Additionally creating a window with a maximized
      // show state results in an invisible window if the window is a PWA
      // (i.e. out-of-process remote cocoa) window
      // (https://crbug.com/1441966). Never using WindowShowState::kMaximized
      // on Mac is also consistent with NativeWidgetMac::Show, which does not
      // support WindowShowState::kMaximized either.
#if !BUILDFLAG(IS_MAC)
      if (*show_state == ui::mojom::WindowShowState::kDefault &&
          window->IsMaximized()) {
        *show_state = ui::mojom::WindowShowState::kMaximized;
      }
#endif
      return true;
    }

    return false;
  }

 private:
  static std::optional<gfx::Rect> RectFromPrefixedPref(
      const base::Value::Dict* pref,
      const std::string& prefix) {
    if (!pref) {
      return std::nullopt;
    }

    std::optional<int> top, left, bottom, right;

    top = pref->FindInt(prefix + "top");
    left = pref->FindInt(prefix + "left");
    bottom = pref->FindInt(prefix + "bottom");
    right = pref->FindInt(prefix + "right");

    if (!top || !left || !bottom || !right) {
      return std::nullopt;
    }

    return gfx::Rect(left.value(), top.value(),
                     std::max(0, right.value() - left.value()),
                     std::max(0, bottom.value() - top.value()));
  }

  std::string app_name_;

  // If set, is used as the reference browser for GetLastActiveWindowState.
  raw_ptr<const Browser> browser_;
};

}  // namespace

WindowSizer::WindowSizer(std::unique_ptr<StateProvider> state_provider,
                         const Browser* browser)
    : state_provider_(std::move(state_provider)), browser_(browser) {}

WindowSizer::~WindowSizer() = default;

// static
void WindowSizer::GetBrowserWindowBoundsAndShowState(
    const gfx::Rect& specified_bounds,
    const Browser* browser,
    gfx::Rect* window_bounds,
    ui::mojom::WindowShowState* show_state) {
  return GetBrowserWindowBoundsAndShowState(
      std::make_unique<DefaultStateProvider>(browser), specified_bounds,
      browser, window_bounds, show_state);
}

#if !BUILDFLAG(IS_LINUX)
// Linux has its own implementation, see WindowSizerLinux.
// static
void WindowSizer::GetBrowserWindowBoundsAndShowState(
    std::unique_ptr<StateProvider> state_provider,
    const gfx::Rect& specified_bounds,
    const Browser* browser,
    gfx::Rect* bounds,
    ui::mojom::WindowShowState* show_state) {
  DCHECK(bounds);
  DCHECK(show_state);
#if BUILDFLAG(IS_CHROMEOS)
  WindowSizerChromeOS sizer(std::move(state_provider), browser);
#else
  WindowSizer sizer(std::move(state_provider), browser);
#endif
  // Pre-populate the window state with our default.
  *show_state = GetWindowDefaultShowState(browser);
  *bounds = specified_bounds;
  sizer.DetermineWindowBoundsAndShowState(specified_bounds, bounds, show_state);
}
#endif  // !BUILDFLAG(IS_LINUX)

void WindowSizer::DetermineWindowBoundsAndShowState(
    const gfx::Rect& specified_bounds,
    gfx::Rect* bounds,
    ui::mojom::WindowShowState* show_state) {
  if (bounds->IsEmpty()) {
    // See if there's last active window's placement information.
    if (GetLastActiveWindowBounds(bounds, show_state)) {
      return;
    }
    // See if there's saved placement information.
    if (GetSavedWindowBounds(bounds, show_state)) {
      return;
    }

    // No saved placement, figure out some sensible default size based on
    // the user's screen size.
    *bounds = GetDefaultWindowBounds(GetDisplayForNewWindow());
    return;
  }

  // In case that there was a bound given we need to make sure that it is
  // visible and fits on the screen.
  // Find the size of the work area of the monitor that intersects the bounds
  // of the anchor window. Note: AdjustBoundsToBeVisibleOnMonitorContaining
  // does not exactly what we want: It makes only sure that "a minimal part"
  // is visible on the screen.
  gfx::Rect work_area =
      display::Screen::Get()->GetDisplayMatching(*bounds).work_area();

  AdjustWorkAreaForPlatform(work_area);

  // Resize so that it fits.
  bounds->AdjustToFit(work_area);
}

void WindowSizer::AdjustWorkAreaForPlatform(gfx::Rect& work_area) {}

bool WindowSizer::GetLastActiveWindowBounds(
    gfx::Rect* bounds,
    ui::mojom::WindowShowState* show_state) const {
  DCHECK(bounds);
  DCHECK(show_state);
  if (!state_provider_.get() ||
      !state_provider_->GetLastActiveWindowState(bounds, show_state)) {
    return false;
  }
  bounds->Offset(kWindowTilePixels, kWindowTilePixels);
  AdjustBoundsToBeVisibleOnDisplay(
      display::Screen::Get()->GetDisplayMatching(*bounds), gfx::Rect(), bounds);
  return true;
}

bool WindowSizer::GetSavedWindowBounds(
    gfx::Rect* bounds,
    ui::mojom::WindowShowState* show_state) const {
  DCHECK(bounds);
  DCHECK(show_state);
  gfx::Rect saved_work_area;
  if (!state_provider_.get() || !state_provider_->GetPersistentState(
                                    bounds, &saved_work_area, show_state)) {
    return false;
  }
  AdjustBoundsToBeVisibleOnDisplay(GetDisplayForNewWindow(*bounds),
                                   saved_work_area, bounds);
  return true;
}

gfx::Rect WindowSizer::GetDefaultWindowBounds(
    const display::Display& display) const {
  gfx::Rect work_area = display.work_area();

  // The default size is either some reasonably wide width, or if the work
  // area is narrower, then the work area width less some aesthetic padding.
  int default_width = std::min(work_area.width() - 2 * kWindowTilePixels,
                               kWindowMaxDefaultWidth);
  int default_height = work_area.height() - 2 * kWindowTilePixels;

#if !BUILDFLAG(IS_MAC)
  // For wider aspect ratio displays at higher resolutions, we might size the
  // window narrower to allow two windows to easily be placed side-by-side.
  gfx::Rect screen_size = display::Screen::Get()->GetPrimaryDisplay().bounds();
  double width_to_height =
      static_cast<double>(screen_size.width()) / screen_size.height();

  // The least wide a screen can be to qualify for the halving described above.
  static const int kMinScreenWidthForWindowHalving = 1600;
  // We assume 16:9/10 is a fairly standard indicator of a wide aspect ratio
  // computer display.
  if (((width_to_height * 10) >= 16) &&
      work_area.width() > kMinScreenWidthForWindowHalving) {
    // Halve the work area, subtracting aesthetic padding on either side.
    // The padding is set so that two windows, side by side have
    // kWindowTilePixels between screen edge and each other.
    default_width =
        static_cast<int>(work_area.width() / 2. - 1.5 * kWindowTilePixels);
  }
#endif  // !BUILDFLAG(IS_MAC)
  return gfx::Rect(kWindowTilePixels + work_area.x(),
                   kWindowTilePixels + work_area.y(), default_width,
                   default_height);
}

void WindowSizer::AdjustBoundsToBeVisibleOnDisplay(
    const display::Display& display,
    const gfx::Rect& saved_work_area,
    gfx::Rect* bounds) const {
  CHECK(bounds);

  // If |bounds| is empty, reset to the default size.
  if (bounds->IsEmpty()) {
    gfx::Rect default_bounds = GetDefaultWindowBounds(display);
    if (bounds->height() <= 0) {
      bounds->set_height(default_bounds.height());
    }
    if (bounds->width() <= 0) {
      bounds->set_width(default_bounds.width());
    }
  }

  // Ensure the minimum height and width.
  bounds->set_height(std::max(kMinVisibleHeight, bounds->height()));
  bounds->set_width(std::max(kMinVisibleWidth, bounds->width()));

  const gfx::Rect work_area = display.work_area();
  CHECK(!work_area.IsEmpty());
  // Ensure that the title bar is not above the work area.
  if (bounds->y() < work_area.y()) {
    bounds->set_y(work_area.y());
  }

  // Reposition and resize the bounds if the saved_work_area is different from
  // the current work area and the current work area doesn't completely contain
  // the bounds.
  if (!saved_work_area.IsEmpty() && saved_work_area != work_area &&
      !work_area.Contains(*bounds)) {
    bounds->AdjustToFit(work_area);
  }

#if BUILDFLAG(IS_MAC)
  bounds->set_height(std::min(work_area.height(), bounds->height()));

  // On mac, we want to be aggressive about repositioning windows that are
  // partially offscreen.  If the window is partially offscreen horizontally,
  // move it to be flush with the left edge of the work area.
  if (bounds->x() < work_area.x() || bounds->right() > work_area.right()) {
    bounds->set_x(work_area.x());
  }

  // If the window is partially offscreen vertically, move it to be flush with
  // the top of the work area.
  if (bounds->y() < work_area.y() || bounds->bottom() > work_area.bottom()) {
    bounds->set_y(work_area.y());
  }
#else
  // On non-Mac platforms, we are less aggressive about repositioning. Simply
  // ensure that at least kMinVisibleWidth * kMinVisibleHeight is visible or
  // `kMinVisibleRatio` of width and height is visible on ChromeOS.
  int min_visible_width = kMinVisibleWidth;
  int min_visible_height = kMinVisibleHeight;
#if BUILDFLAG(IS_CHROMEOS)
  min_visible_width = std::max(
      min_visible_width, base::ClampRound(bounds->width() * kMinVisibleRatio));
  min_visible_height =
      std::max(min_visible_height,
               base::ClampRound(bounds->height() * kMinVisibleRatio));
#endif  // BUILDFLAG(IS_CHROMEOS)
  const int min_y = work_area.y() + min_visible_height - bounds->height();
  const int min_x = work_area.x() + min_visible_width - bounds->width();
  const int max_y = work_area.bottom() - min_visible_height;
  const int max_x = work_area.right() - min_visible_width;
  // Reposition and resize the bounds to make it fully visible inside the work
  // area if the work area and bounds are both small.
  // `min_x >= max_x` happens when `work_area.width() + bounds.width() <= 2 *
  // min_visible_width`. Similar for `min_y >= max_y` in height dimension.
  if (min_x >= max_x || min_y >= max_y) {
    bounds->AdjustToFit(work_area);
  } else {
    bounds->set_y(std::clamp(bounds->y(), min_y, max_y));
    bounds->set_x(std::clamp(bounds->x(), min_x, max_x));
  }
#endif  // BUILDFLAG(IS_MAC)
}

// static
ui::mojom::WindowShowState WindowSizer::GetWindowDefaultShowState(
    const Browser* browser) {
  if (!browser) {
    return ui::mojom::WindowShowState::kDefault;
  }

  // Only tabbed browsers and dev tools use the command line.
  bool use_command_line =
      browser->is_type_normal() || browser->is_type_devtools();

#if defined(USE_AURA)
  // We use the apps save state as well on aura.
  use_command_line = use_command_line || browser->is_type_app() ||
                     browser->is_type_app_popup();
#endif

  if (use_command_line && base::CommandLine::ForCurrentProcess()->HasSwitch(
                              switches::kStartMaximized)) {
    return ui::mojom::WindowShowState::kMaximized;
  }

  return browser->initial_show_state();
}

// static
display::Display WindowSizer::GetDisplayForNewWindow(const gfx::Rect& bounds) {
#if BUILDFLAG(IS_CHROMEOS)
  // Prefer the display where the user last activated a window.
  return display::Screen::Get()->GetDisplayForNewWindows();
#else
  return display::Screen::Get()->GetDisplayMatching(bounds);
#endif  // BUILDFLAG(IS_CHROMEOS)
}