blob: 273c033d96987aa134cd317e23704a3f5a8dc5a2 [file] [log] [blame]
/*
* Copyright (C) 2012 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include "third_party/blink/renderer/core/page/validation_message_client_impl.h"
#include <algorithm>
#include <memory>
#include <utility>
#include "cc/layers/picture_layer.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/public/web/web_text_direction.h"
#include "third_party/blink/renderer/core/accessibility/ax_object_cache.h"
#include "third_party/blink/renderer/core/dom/element.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/validation_message_overlay_delegate.h"
#include "third_party/blink/renderer/platform/web_test_support.h"
namespace blink {
ValidationMessageClientImpl::ValidationMessageClientImpl(Page& page)
: page_(&page), current_anchor_(nullptr) {}
ValidationMessageClientImpl* ValidationMessageClientImpl::Create(Page& page) {
return MakeGarbageCollected<ValidationMessageClientImpl>(page);
}
ValidationMessageClientImpl::~ValidationMessageClientImpl() = default;
LocalFrameView* ValidationMessageClientImpl::CurrentView() {
return current_anchor_->GetDocument().View();
}
void ValidationMessageClientImpl::ShowValidationMessage(
const Element& anchor,
const String& message,
TextDirection message_dir,
const String& sub_message,
TextDirection sub_message_dir) {
if (message.IsEmpty()) {
HideValidationMessage(anchor);
return;
}
if (!anchor.GetLayoutObject())
return;
if (current_anchor_)
HideValidationMessageImmediately(*current_anchor_);
current_anchor_ = &anchor;
message_ = message;
page_->GetChromeClient().RegisterPopupOpeningObserver(this);
constexpr auto kMinimumTimeToShowValidationMessage =
TimeDelta::FromSeconds(5);
constexpr auto kTimePerCharacter = TimeDelta::FromMilliseconds(50);
finish_time_ =
CurrentTimeTicks() +
std::max(kMinimumTimeToShowValidationMessage,
(message.length() + sub_message.length()) * kTimePerCharacter);
auto* target_frame = page_->MainFrame() && page_->MainFrame()->IsLocalFrame()
? ToLocalFrame(page_->MainFrame())
: &anchor.GetDocument().GetFrame()->LocalFrameRoot();
allow_initial_empty_anchor_ = !target_frame->IsMainFrame();
auto delegate = ValidationMessageOverlayDelegate::Create(
*page_, anchor, message_, message_dir, sub_message, sub_message_dir);
overlay_delegate_ = delegate.get();
overlay_ = FrameOverlay::Create(target_frame, std::move(delegate));
bool success =
target_frame->View()->UpdateLifecycleToCompositingCleanPlusScrolling();
ValidationMessageVisibilityChanged(anchor);
// The lifecycle update should always succeed, because this is not inside
// of a throttling scope.
DCHECK(success);
LayoutOverlay();
}
void ValidationMessageClientImpl::HideValidationMessage(const Element& anchor) {
if (WebTestSupport::IsRunningWebTest()) {
HideValidationMessageImmediately(anchor);
return;
}
if (!current_anchor_ || !IsValidationMessageVisible(anchor) ||
overlay_delegate_->IsHiding()) {
// Do not continue if already hiding, otherwise timer will never complete
// and Reset() is never called.
return;
}
DCHECK(overlay_);
overlay_delegate_->StartToHide();
timer_ = std::make_unique<TaskRunnerTimer<ValidationMessageClientImpl>>(
anchor.GetDocument().GetTaskRunner(TaskType::kInternalDefault), this,
&ValidationMessageClientImpl::Reset);
// This should be equal to or larger than transition duration of
// #container.hiding in validation_bubble.css.
const TimeDelta kHidingAnimationDuration = TimeDelta::FromSecondsD(0.13333);
timer_->StartOneShot(kHidingAnimationDuration, FROM_HERE);
}
void ValidationMessageClientImpl::HideValidationMessageImmediately(
const Element& anchor) {
if (!current_anchor_ || !IsValidationMessageVisible(anchor))
return;
Reset(nullptr);
}
void ValidationMessageClientImpl::Reset(TimerBase*) {
const Element& anchor = *current_anchor_;
timer_ = nullptr;
current_anchor_ = nullptr;
message_ = String();
finish_time_ = TimeTicks();
overlay_ = nullptr;
overlay_delegate_ = nullptr;
page_->GetChromeClient().UnregisterPopupOpeningObserver(this);
ValidationMessageVisibilityChanged(anchor);
}
void ValidationMessageClientImpl::ValidationMessageVisibilityChanged(
const Element& element) {
Document& document = element.GetDocument();
if (AXObjectCache* cache = document.ExistingAXObjectCache())
cache->HandleValidationMessageVisibilityChanged(&element);
}
bool ValidationMessageClientImpl::IsValidationMessageVisible(
const Element& anchor) {
return current_anchor_ == &anchor;
}
void ValidationMessageClientImpl::DocumentDetached(const Document& document) {
if (current_anchor_ && current_anchor_->GetDocument() == document)
HideValidationMessageImmediately(*current_anchor_);
}
void ValidationMessageClientImpl::CheckAnchorStatus(TimerBase*) {
DCHECK(current_anchor_);
if ((!WebTestSupport::IsRunningWebTest() &&
CurrentTimeTicks() >= finish_time_) ||
!CurrentView()) {
HideValidationMessage(*current_anchor_);
return;
}
IntRect new_anchor_rect_in_viewport =
current_anchor_->VisibleBoundsInVisualViewport();
if (new_anchor_rect_in_viewport.IsEmpty()) {
// In a remote frame, VisibleBoundsInVisualViewport() returns an empty
// rectangle for a while after initial load or scrolling. So we don't
// hide the validation bubble until we see a non-empty rectable.
if (!allow_initial_empty_anchor_) {
HideValidationMessage(*current_anchor_);
return;
}
} else {
allow_initial_empty_anchor_ = false;
}
}
void ValidationMessageClientImpl::WillBeDestroyed() {
if (current_anchor_)
HideValidationMessageImmediately(*current_anchor_);
}
void ValidationMessageClientImpl::WillOpenPopup() {
if (current_anchor_)
HideValidationMessage(*current_anchor_);
}
void ValidationMessageClientImpl::LayoutOverlay() {
if (!overlay_)
return;
CheckAnchorStatus(nullptr);
if (overlay_)
overlay_->Update();
}
void ValidationMessageClientImpl::PaintOverlay() {
DCHECK(!RuntimeEnabledFeatures::CompositeAfterPaintEnabled());
if (overlay_ && overlay_->GetGraphicsLayer())
overlay_->GetGraphicsLayer()->Paint();
}
void ValidationMessageClientImpl::PaintOverlay(GraphicsContext& context) {
DCHECK(RuntimeEnabledFeatures::CompositeAfterPaintEnabled());
if (overlay_)
overlay_->Paint(context);
}
void ValidationMessageClientImpl::Trace(blink::Visitor* visitor) {
visitor->Trace(page_);
visitor->Trace(current_anchor_);
ValidationMessageClient::Trace(visitor);
}
} // namespace blink