1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
|
// Copyright 2022 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/chromeos/app_mode/kiosk_browser_window_handler.h"
#include <memory>
#include <tuple>
#include <utility>
#include "base/check_deref.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/functional/function_ref.h"
#include "base/location.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "chrome/browser/chromeos/app_mode/kiosk_policies.h"
#include "chrome/browser/chromeos/app_mode/kiosk_settings_navigation_throttle.h"
#include "chrome/browser/chromeos/app_mode/kiosk_troubleshooting_controller_ash.h"
#include "chrome/browser/ui/ash/system_web_apps/system_web_app_ui_utils.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_commands.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_navigator.h"
#include "chrome/browser/ui/browser_window.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_delegate.h"
namespace chromeos {
namespace {
constexpr base::TimeDelta kCloseBrowserTimeout = base::Seconds(2);
#define WINDOW_ALLOWED true
void MakeWindowResizable(BrowserWindow* window) {
views::Widget* widget =
views::Widget::GetWidgetForNativeWindow(window->GetNativeWindow());
if (widget) {
widget->widget_delegate()->SetCanResize(true);
}
}
content::WebContents* GetActiveWebContents(const Browser* browser) {
return browser->tab_strip_model()->GetActiveWebContents();
}
std::string GetUrlOfActiveTab(const Browser* browser) {
content::WebContents* active_tab = GetActiveWebContents(browser);
return active_tab ? active_tab->GetVisibleURL().spec() : std::string();
}
void CloseBrowser(Browser* browser) {
// We prefer to use `browser->tab_strip_model()->CloseAllTabs`, because
// `browser->window()->Close()` can silently fail if the window is currently
// being dragged. However, `CloseAllTabs` becomes a no-op if no tabs are
// present, so we fall back to `browser->window()->Close()` for that case.
if (!browser->tab_strip_model()->empty()) {
browser->tab_strip_model()->CloseAllTabs();
} else {
browser->window()->Close();
}
}
} // namespace
const char kKioskNewBrowserWindowHistogram[] = "Kiosk.NewBrowserWindow";
class NavigationWaiter : content::WebContentsObserver {
public:
NavigationWaiter(Browser* browser, base::OnceClosure callback)
: browser_(browser), callback_(std::move(callback)) {
content::WebContents* web_contents = GetActiveWebContents(browser);
if (!web_contents) {
// If no WebContents is present, we'll continue to triaging without a url.
// This is more restrictive and will likely result in the browser window
// being closed.
// One known case of this is a picture-in-picture browser.
LOG(WARNING) << "New browser without WebContents detected.";
RunCallback();
return;
}
if (web_contents->GetVisibleURL().is_empty()) {
LOG(WARNING)
<< "New browser with empty url detected, Waiting for navigation.";
Observe(GetActiveWebContents(browser));
} else {
RunCallback();
}
}
NavigationWaiter(const NavigationWaiter&) = delete;
NavigationWaiter& operator=(const NavigationWaiter&) = delete;
private:
// content::WebContentsObserver
void DidStartNavigation(content::NavigationHandle* navigation) override {
RunCallback();
}
void RunCallback() {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, std::move(callback_));
}
raw_ptr<Browser> browser_;
base::OnceClosure callback_;
};
KioskBrowserWindowHandler::KioskBrowserWindowHandler(
Profile* profile,
const std::optional<std::string>& web_app_name,
base::RepeatingCallback<void(bool is_closing)>
on_browser_window_added_callback,
base::OnceClosure shutdown_kiosk_browser_session_callback)
: profile_(profile),
web_app_name_(web_app_name),
on_browser_window_added_callback_(on_browser_window_added_callback),
shutdown_kiosk_browser_session_callback_(
std::move(shutdown_kiosk_browser_session_callback)),
kiosk_policies_(profile_->GetPrefs()) {
kiosk_troubleshooting_controller_ =
std::make_unique<ash::KioskTroubleshootingControllerAsh>(
profile_->GetPrefs(),
base::BindOnce(&KioskBrowserWindowHandler::Shutdown,
weak_ptr_factory_.GetWeakPtr()));
CloseAllUnexpectedBrowserWindows();
BrowserList::AddObserver(this);
}
KioskBrowserWindowHandler::~KioskBrowserWindowHandler() {
BrowserList::RemoveObserver(this);
}
bool KioskBrowserWindowHandler::TriageNewBrowserWindow(Browser* browser) {
url_waiters_.erase(browser);
std::string url_string = GetUrlOfActiveTab(browser);
if (KioskSettingsNavigationThrottle::IsSettingsPage(url_string)) {
base::UmaHistogramEnumeration(kKioskNewBrowserWindowHistogram,
KioskBrowserWindowType::kSettingsPage);
HandleNewSettingsWindow(browser, url_string);
on_browser_window_added_callback_.Run(/*is_closing=*/false);
return WINDOW_ALLOWED;
}
if (IsNewBrowserWindowAllowed(browser)) {
base::UmaHistogramEnumeration(
kKioskNewBrowserWindowHistogram,
KioskBrowserWindowType::kOpenedRegularBrowser);
LOG(WARNING) << "Open additional fullscreen browser window in kiosk session"
<< ", url=" << url_string;
chrome::ToggleFullscreenMode(browser, /*user_initiated=*/false);
on_browser_window_added_callback_.Run(/*is_closing=*/false);
return WINDOW_ALLOWED;
}
if (IsDevToolsAllowedBrowser(browser)) {
MakeWindowResizable(browser->window());
base::UmaHistogramEnumeration(
kKioskNewBrowserWindowHistogram,
KioskBrowserWindowType::kOpenedDevToolsBrowser);
on_browser_window_added_callback_.Run(/*is_closing=*/false);
return WINDOW_ALLOWED;
}
if (IsNormalTroubleshootingBrowserAllowed(browser)) {
MakeWindowResizable(browser->window());
base::UmaHistogramEnumeration(
kKioskNewBrowserWindowHistogram,
KioskBrowserWindowType::kOpenedTroubleshootingNormalBrowser);
on_browser_window_added_callback_.Run(/*is_closing=*/false);
return WINDOW_ALLOWED;
}
base::UmaHistogramEnumeration(kKioskNewBrowserWindowHistogram,
KioskBrowserWindowType::kClosedRegularBrowser);
LOG(WARNING) << "Force close browser opened in kiosk session"
<< ", url=" << url_string;
CloseBrowserAndSetTimer(browser);
on_browser_window_added_callback_.Run(/*is_closing=*/true);
return !WINDOW_ALLOWED;
}
void KioskBrowserWindowHandler::HandleNewSettingsWindow(
Browser* browser,
const std::string& url_string) {
if (settings_browser_) {
// If another settings browser exist, navigate to `url_string` in the
// existing browser.
CloseBrowserAndSetTimer(browser);
// Navigate in the existing browser.
NavigateParams nav_params(
settings_browser_, GURL(url_string),
ui::PageTransition::PAGE_TRANSITION_AUTO_TOPLEVEL);
nav_params.window_action = NavigateParams::SHOW_WINDOW;
Navigate(&nav_params);
return;
}
bool app_browser = browser->is_type_app() || browser->is_type_app_popup() ||
browser->is_type_popup();
if (!app_browser) {
// If this browser is not an app browser, create a new app browser if none
// yet exists.
CloseBrowserAndSetTimer(browser);
// Create a new app browser.
NavigateParams nav_params(
profile_, GURL(url_string),
ui::PageTransition::PAGE_TRANSITION_AUTO_TOPLEVEL);
nav_params.disposition = WindowOpenDisposition::NEW_POPUP;
Navigate(&nav_params);
// We do not save the newly created browser to the `settings_browser_` here
// because this new browser will be handled by this function after creation,
// and it will be saved there.
return;
}
settings_browser_ = browser;
// We have to first call Restore() because the window was created as a
// fullscreen window, having no prior bounds.
// TODO(crbug.com/40103687): Figure out how to do it more cleanly.
browser->window()->Restore();
browser->window()->Maximize();
}
void KioskBrowserWindowHandler::CloseAllUnexpectedBrowserWindows() {
CloseBrowserWindowsIf([&web_app_name =
web_app_name_](const Browser& browser) {
// Do not close the main web app window (if any).
bool is_web_app = web_app_name.has_value();
bool is_web_app_window = is_web_app && (browser.app_name() == web_app_name);
return !is_web_app_window;
});
}
void KioskBrowserWindowHandler::OnBrowserAdded(Browser* browser) {
// At this point no WebContents has been added to the browser, so we need to
// post once to ensure we have a WebContents.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&KioskBrowserWindowHandler::OnCompleteBrowserAdded,
weak_ptr_factory_.GetWeakPtr(), browser));
}
void KioskBrowserWindowHandler::OnCompleteBrowserAdded(Browser* browser) {
// Hide the window until it is triaged.
browser->window()->Hide();
// At this point the URL being opened might still be unknown.
// This URL is required for our triaging, so we'll wait for it.
url_waiters_[browser] = std::make_unique<NavigationWaiter>(
browser, base::BindOnce(
[](KioskBrowserWindowHandler* self, Browser* browser) {
if (self->TriageNewBrowserWindow(browser)) {
browser->window()->Show();
}
},
base::Unretained(this), base::Unretained(browser)));
}
void KioskBrowserWindowHandler::OnBrowserRemoved(Browser* browser) {
url_waiters_.erase(browser);
closing_browsers_.erase(browser);
// Exit the kiosk session if the last browser was closed.
if (ShouldExitKioskWhenLastBrowserRemoved() &&
BrowserList::GetInstance()->empty()) {
LOG(WARNING) << "Last browser window closed, ending kiosk session.";
Shutdown();
}
if (browser == settings_browser_) {
settings_browser_ = nullptr;
} else if (ShouldExitKioskWhenLastBrowserRemoved() &&
IsOnlySettingsBrowserRemainOpen()) {
// Only `settings_browser_` is opened and there are no app browsers anymore.
// So we should close `settings_browser_` and it will end the kiosk session.
CloseBrowserAndSetTimer(settings_browser_);
}
}
bool KioskBrowserWindowHandler::IsNewBrowserWindowAllowed(
Browser* browser) const {
return kiosk_policies_.IsWindowCreationAllowed() &&
browser->is_type_app_popup() && web_app_name_.has_value() &&
browser->app_name() == web_app_name_.value();
}
bool KioskBrowserWindowHandler::IsDevToolsAllowedBrowser(
Browser* browser) const {
return browser->is_type_devtools() &&
kiosk_troubleshooting_controller_
->AreKioskTroubleshootingToolsEnabled();
}
bool KioskBrowserWindowHandler::IsNormalTroubleshootingBrowserAllowed(
Browser* browser) const {
return browser->is_type_normal() &&
kiosk_troubleshooting_controller_
->AreKioskTroubleshootingToolsEnabled();
}
bool KioskBrowserWindowHandler::ShouldExitKioskWhenLastBrowserRemoved() const {
return web_app_name_.has_value();
}
bool KioskBrowserWindowHandler::IsOnlySettingsBrowserRemainOpen() const {
return settings_browser_ && BrowserList::GetInstance()->size() == 1 &&
BrowserList::GetInstance()->get(0) == settings_browser_;
}
void KioskBrowserWindowHandler::Shutdown() {
if (!shutdown_kiosk_browser_session_callback_.is_null()) {
std::move(shutdown_kiosk_browser_session_callback_).Run();
}
}
void KioskBrowserWindowHandler::CloseBrowserWindowsIf(
base::FunctionRef<bool(const Browser&)> filter) {
for (Browser* browser : CHECK_DEREF(BrowserList::GetInstance())) {
if (filter(*browser)) {
LOG(WARNING) << "kiosk: Closing unexpected browser window with url "
<< GetUrlOfActiveTab(browser) << " of app "
<< browser->app_name();
CloseBrowserAndSetTimer(browser);
}
}
}
void KioskBrowserWindowHandler::CloseBrowserAndSetTimer(Browser* browser) {
closing_browsers_.emplace(std::piecewise_construct, std::make_tuple(browser),
std::make_tuple());
closing_browsers_[browser].Start(
FROM_HERE, kCloseBrowserTimeout,
base::BindOnce(&KioskBrowserWindowHandler::OnCloseBrowserTimeout,
weak_ptr_factory_.GetWeakPtr()));
CloseBrowser(browser);
}
void KioskBrowserWindowHandler::OnCloseBrowserTimeout() {
NOTREACHED() << "Failed to close unexpected browser window.";
}
} // namespace chromeos
|