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
|
// 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 "components/web_modal/web_contents_modal_dialog_manager.h"
#include <utility>
#include "base/check.h"
#include "base/ranges/algorithm.h"
#include "components/back_forward_cache/back_forward_cache_disable.h"
#include "components/web_modal/web_contents_modal_dialog_manager_delegate.h"
#include "content/public/browser/back_forward_cache.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/web_contents.h"
#include "net/base/registry_controlled_domains/registry_controlled_domain.h"
using content::WebContents;
namespace web_modal {
WebContentsModalDialogManager::~WebContentsModalDialogManager() {
DCHECK(child_dialogs_.empty());
}
void WebContentsModalDialogManager::SetDelegate(
WebContentsModalDialogManagerDelegate* d) {
delegate_ = d;
for (const auto& dialog : child_dialogs_) {
// Delegate can be null on Views/Win32 during tab drag.
dialog.manager->HostChanged(d ? d->GetWebContentsModalDialogHost()
: nullptr);
}
}
// TODO(gbillock): Maybe "ShowBubbleWithManager"?
void WebContentsModalDialogManager::ShowDialogWithManager(
gfx::NativeWindow dialog,
std::unique_ptr<SingleWebContentsDialogManager> manager) {
if (delegate_)
manager->HostChanged(delegate_->GetWebContentsModalDialogHost());
child_dialogs_.emplace_back(dialog, std::move(manager));
if (child_dialogs_.size() == 1) {
BlockWebContentsInteraction(true);
if (delegate_ && delegate_->IsWebContentsVisible(web_contents()))
child_dialogs_.back().manager->Show();
}
}
bool WebContentsModalDialogManager::IsDialogActive() const {
return !child_dialogs_.empty();
}
void WebContentsModalDialogManager::FocusTopmostDialog() const {
DCHECK(!child_dialogs_.empty());
child_dialogs_.front().manager->Focus();
}
content::WebContents* WebContentsModalDialogManager::GetWebContents() const {
return web_contents();
}
void WebContentsModalDialogManager::WillClose(gfx::NativeWindow dialog) {
auto dlg = base::ranges::find(child_dialogs_, dialog, &DialogState::dialog);
// The Views tab contents modal dialog calls WillClose twice. Ignore the
// second invocation.
if (dlg == child_dialogs_.end())
return;
bool removed_topmost_dialog = dlg == child_dialogs_.begin();
child_dialogs_.erase(dlg);
if (!closing_all_dialogs_ &&
(!child_dialogs_.empty() && removed_topmost_dialog) &&
(delegate_ && delegate_->IsWebContentsVisible(web_contents()))) {
child_dialogs_.front().manager->Show();
}
BlockWebContentsInteraction(!child_dialogs_.empty());
}
WebContentsModalDialogManager::WebContentsModalDialogManager(
content::WebContents* web_contents)
: content::WebContentsObserver(web_contents),
content::WebContentsUserData<WebContentsModalDialogManager>(
*web_contents),
web_contents_is_hidden_(web_contents->GetVisibility() ==
content::Visibility::HIDDEN) {}
WebContentsModalDialogManager::DialogState::DialogState(
gfx::NativeWindow dialog,
std::unique_ptr<SingleWebContentsDialogManager> mgr)
: dialog(dialog), manager(std::move(mgr)) {}
WebContentsModalDialogManager::DialogState::DialogState(DialogState&& state) =
default;
WebContentsModalDialogManager::DialogState::~DialogState() = default;
// TODO(gbillock): Move this to Views impl within Show()? It would
// call WebContents* contents = native_delegate_->GetWebContents(); and
// then set the block state. Advantage: could restrict some of the
// WCMDM delegate methods, then, and pass them behind the scenes.
void WebContentsModalDialogManager::BlockWebContentsInteraction(bool blocked) {
WebContents* contents = web_contents();
if (!contents) {
// The WebContents has already disconnected.
return;
}
if (blocked) {
scoped_ignore_input_events_ = contents->IgnoreInputEvents();
} else {
scoped_ignore_input_events_.reset();
}
if (delegate_)
delegate_->SetWebContentsBlocked(contents, blocked);
}
void WebContentsModalDialogManager::CloseAllDialogs() {
closing_all_dialogs_ = true;
// Clear out any dialogs since we are leaving this page entirely.
while (!child_dialogs_.empty()) {
child_dialogs_.front().manager->Close();
}
closing_all_dialogs_ = false;
}
void WebContentsModalDialogManager::DidFinishNavigation(
content::NavigationHandle* navigation_handle) {
if (!navigation_handle->IsInPrimaryMainFrame() ||
!navigation_handle->HasCommitted())
return;
if (!child_dialogs_.empty()) {
// Disable BFCache for the page which had any modal dialog open.
// This prevents the page which has print, confirm form resubmission, http
// password dialogs, etc. to go in to BFCache. We can't simply dismiss the
// dialogs in the case, since they are requesting meaningful input from the
// user that affects the loading or display of the content.
content::BackForwardCache::DisableForRenderFrameHost(
navigation_handle->GetPreviousRenderFrameHostId(),
back_forward_cache::DisabledReason(
back_forward_cache::DisabledReasonId::kModalDialog));
}
// Close constrained windows if necessary.
if (!net::registry_controlled_domains::SameDomainOrHost(
navigation_handle->GetPreviousPrimaryMainFrameURL(),
navigation_handle->GetURL(),
net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES))
CloseAllDialogs();
}
void WebContentsModalDialogManager::DidGetIgnoredUIEvent() {
if (!child_dialogs_.empty()) {
child_dialogs_.front().manager->Focus();
}
}
void WebContentsModalDialogManager::OnVisibilityChanged(
content::Visibility visibility) {
const bool web_contents_was_hidden = web_contents_is_hidden_;
web_contents_is_hidden_ = visibility == content::Visibility::HIDDEN;
if (child_dialogs_.empty()) {
return;
}
const bool state_changed = web_contents_is_hidden_ != web_contents_was_hidden;
if (web_contents_is_hidden_) {
if (state_changed) {
child_dialogs_.front().manager->Hide();
}
} else {
// Show the dialog if it transitioned from HIDDEN to VISIBLE or OCCLUDED, or
// from OCCLUDED to VISIBLE if the dialog is no longer active.
// TODO(crbug.com/1487345): Add an interaction test for this.
if (state_changed || !child_dialogs_.front().manager->IsActive()) {
child_dialogs_.front().manager->Show();
}
}
}
void WebContentsModalDialogManager::WebContentsDestroyed() {
// First cleanly close all child dialogs.
// TODO(mpcomplete): handle case if MaybeCloseChildWindows() already asked
// some of these to close. CloseAllDialogs is async, so it might get called
// twice before it runs.
CloseAllDialogs();
}
WEB_CONTENTS_USER_DATA_KEY_IMPL(WebContentsModalDialogManager);
} // namespace web_modal
|