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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ash/quick_insert/views/quick_insert_feature_tour.h"
#include <memory>
#include <string>
#include <utility>
#include "ash/constants/ash_features.h"
#include "ash/constants/ash_pref_names.h"
#include "ash/quick_insert/resources/grit/quick_insert_resources.h"
#include "ash/strings/grit/ash_strings.h"
#include "ash/style/pill_button.h"
#include "ash/style/system_dialog_delegate_view.h"
#include "base/check_op.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/location.h"
#include "base/task/sequenced_task_runner.h"
#include "build/branding_buildflags.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"
#include "ui/aura/window.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/metadata/metadata_impl_macros.h"
#include "ui/base/models/image_model.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/base/ui_base_types.h"
#include "ui/chromeos/styles/cros_tokens_color_mappings.h"
#include "ui/compositor/layer.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/gfx/geometry/rounded_corners_f.h"
#include "ui/views/background.h"
#include "ui/views/border.h"
#include "ui/views/controls/image_view.h"
#include "ui/views/highlight_border.h"
#include "ui/views/view_class_properties.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_delegate.h"
#include "ui/wm/public/activation_client.h"
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
#include "chromeos/ash/resources/internal/strings/grit/ash_internal_strings.h"
#endif // BUILDFLAG(GOOGLE_CHROME_BRANDING)
namespace ash {
namespace {
constexpr auto kFeatureTourDialogBorderInsets =
gfx::Insets::TLBR(0, 32, 28, 32);
constexpr int kFeatureTourDialogCornerRadius = 20;
constexpr auto kFeatureTourDialogIllustrationCornerRadii =
gfx::RoundedCornersF(/*upper_left=*/kFeatureTourDialogCornerRadius,
/*upper_right=*/kFeatureTourDialogCornerRadius,
/*lower_right=*/0,
/*lower_left=*/0);
std::u16string GetHeadingText(
QuickInsertFeatureTour::EditorStatus editor_status) {
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
switch (editor_status) {
case QuickInsertFeatureTour::EditorStatus::kEligible:
return l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_WITH_EDITOR_HEADING_TEXT);
case QuickInsertFeatureTour::EditorStatus::kNotEligible:
return l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_WITHOUT_EDITOR_HEADING_TEXT);
}
#else
return u"";
#endif // BUILDFLAG(GOOGLE_CHROME_BRANDING)
}
std::u16string GetBodyText(QuickInsertFeatureTour::EditorStatus editor_status) {
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
switch (editor_status) {
case QuickInsertFeatureTour::EditorStatus::kEligible:
return l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_WITH_EDITOR_BODY_TEXT);
case QuickInsertFeatureTour::EditorStatus::kNotEligible:
return l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_WITHOUT_EDITOR_BODY_TEXT);
}
#else
return u"";
#endif // BUILDFLAG(GOOGLE_CHROME_BRANDING)
}
ui::ImageModel GetIllustration() {
return ui::ResourceBundle::GetSharedInstance().GetThemedLottieImageNamed(
IDR_QUICK_INSERT_FEATURE_TOUR_ILLUSTRATION);
}
std::unique_ptr<views::Widget> CreateWidget(
QuickInsertFeatureTour::EditorStatus editor_status,
base::OnceClosure learn_more_callback,
base::OnceClosure completion_callback) {
auto feature_tour_dialog =
views::Builder<SystemDialogDelegateView>()
.SetBorder(views::CreatePaddedBorder(
std::make_unique<views::HighlightBorder>(
kFeatureTourDialogCornerRadius,
views::HighlightBorder::Type::kHighlightBorderOnShadow),
kFeatureTourDialogBorderInsets))
.SetTitleText(GetHeadingText(editor_status))
.SetDescription(GetBodyText(editor_status))
.SetAcceptButtonText(l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_START_BUTTON_LABEL))
.SetAcceptCallback(std::move(completion_callback))
.SetCancelButtonText(l10n_util::GetStringUTF16(
IDS_PICKER_FEATURE_TOUR_LEARN_MORE_BUTTON_LABEL))
.SetCancelCallback(std::move(learn_more_callback))
.SetTopContentView(
views::Builder<views::ImageView>()
.SetBackground(views::CreateRoundedRectBackground(
cros_tokens::kCrosSysIlloColor12,
kFeatureTourDialogIllustrationCornerRadii))
.SetImage(GetIllustration()))
.SetModalType(ui::mojom::ModalType::kSystem)
.Build();
views::Widget::InitParams params(
views::Widget::InitParams::NATIVE_WIDGET_OWNS_WIDGET,
views::Widget::InitParams::TYPE_POPUP);
params.delegate = feature_tour_dialog.release();
params.name = "QuickInsertFeatureTourWidget";
params.activatable = views::Widget::InitParams::Activatable::kYes;
auto widget = std::make_unique<views::Widget>(std::move(params));
widget->GetLayer()->SetFillsBoundsOpaquely(false);
return widget;
}
} // namespace
QuickInsertFeatureTour::QuickInsertFeatureTour() = default;
QuickInsertFeatureTour::~QuickInsertFeatureTour() {
if (widget_) {
widget_->CloseNow();
}
}
void QuickInsertFeatureTour::RegisterProfilePrefs(
PrefRegistrySimple* registry) {
registry->RegisterBooleanPref(prefs::kQuickInsertFeatureTourCompletedPref,
false);
}
bool QuickInsertFeatureTour::MaybeShowForFirstUse(
PrefService* prefs,
EditorStatus editor_status,
base::RepeatingClosure learn_more_callback,
base::RepeatingClosure completion_callback) {
auto* pref =
prefs->FindPreference(prefs::kQuickInsertFeatureTourCompletedPref);
// Don't show if `pref` is null (this happens in unit tests that don't call
// `RegisterProfilePrefs`).
if (pref == nullptr || pref->GetValue()->GetBool()) {
return false;
}
widget_ = CreateWidget(
editor_status,
base::BindOnce(&QuickInsertFeatureTour::SetOnWindowDeactivatedCallback,
weak_ptr_factory_.GetWeakPtr(),
std::move(learn_more_callback)),
base::BindOnce(&QuickInsertFeatureTour::SetOnWindowDeactivatedCallback,
weak_ptr_factory_.GetWeakPtr(),
std::move(completion_callback)));
aura::Window* window = widget_->GetNativeWindow();
CHECK_NE(window, nullptr);
wm::ActivationClient* activation_client =
wm::GetActivationClient(window->GetRootWindow());
CHECK_NE(activation_client, nullptr);
obs_.Reset();
obs_.Observe(activation_client);
widget_->Show();
prefs->SetBoolean(prefs::kQuickInsertFeatureTourCompletedPref, true);
return true;
}
const views::Button* QuickInsertFeatureTour::learn_more_button_for_testing()
const {
if (!widget_) {
return nullptr;
}
auto* feature_tour_dialog =
static_cast<SystemDialogDelegateView*>(widget_->GetContentsView());
return feature_tour_dialog != nullptr
? feature_tour_dialog->GetCancelButtonForTesting() // IN-TEST
: nullptr;
}
const views::Button* QuickInsertFeatureTour::complete_button_for_testing()
const {
if (!widget_) {
return nullptr;
}
auto* feature_tour_dialog =
static_cast<SystemDialogDelegateView*>(widget_->GetContentsView());
return feature_tour_dialog != nullptr
? feature_tour_dialog->GetAcceptButtonForTesting() // IN-TEST
: nullptr;
}
views::Widget* QuickInsertFeatureTour::widget_for_testing() {
return widget_.get();
}
void QuickInsertFeatureTour::OnWindowActivated(ActivationReason reason,
aura::Window* gained_active,
aura::Window* lost_active) {
RunOnWindowDeactivatedIfNeeded();
}
void QuickInsertFeatureTour::SetOnWindowDeactivatedCallback(
base::OnceClosure callback) {
on_window_deactivated_callback_ = std::move(callback);
RunOnWindowDeactivatedIfNeeded();
}
void QuickInsertFeatureTour::RunOnWindowDeactivatedIfNeeded() {
if (on_window_deactivated_callback_.is_null()) {
return;
}
if (widget_ && obs_.IsObserving() &&
widget_->GetNativeWindow() == obs_.GetSource()->GetActiveWindow()) {
return;
}
// As of writing, this method is called from two code paths:
//
// 1. `OnWindowActivated`, which is called from
// `wm::FocusController::SetActiveWindow`.
// When `OnWindowActivated` is called, the active window should be set... but
// we cannot activate any other windows (such as Quick Insert) synchronously
// due to being in the middle of `wm::FocusController::SetActiveWindow`'s
// "active window stack".
// Doing so will cause a `DCHECK` crash in
// `wm::FocusController::FocusAndActivateWindow` due to the active window
// changing reentrantly. Turning off `DCHECK`s will result in no window
// being shown / activated.
//
// We should only run callbacks after the `SetActiveWindow` "stack" is fully
// resolved to avoid this. The only feasible way of doing this is to post a
// task.
//
// 2. `SetOnWindowDeactivatedCallback`, which is passed in as callbacks to
// `SystemDialogDelegateView`. Those callbacks are called from
// `SystemDialogDelegateView::RunCallbackAndCloseDialog` before the widget is
// closed.
// Therefore, the active window should still be `widget_`'s native window, so
// we should not have gotten to this point.
//
// However, `SystemDialogDelegateView` behaviour might change in the future.
// The worst case would be `SystemDialogDelegateView` changing its behaviour
// to call callbacks during `OnWindowDeactivated`, which would be equivalent
// to the above code path. Therefore, we should also post a task in this
// scenario.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, std::move(on_window_deactivated_callback_));
}
} // namespace ash
|