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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
|
// Copyright 2023 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/system/input_device_settings/pref_handlers/mouse_pref_handler_impl.h"
#include "ash/constants/ash_features.h"
#include "ash/constants/ash_pref_names.h"
#include "ash/public/mojom/input_device_settings.mojom-forward.h"
#include "ash/public/mojom/input_device_settings.mojom.h"
#include "ash/shell.h"
#include "ash/system/input_device_settings/input_device_settings_defaults.h"
#include "ash/system/input_device_settings/input_device_settings_logging.h"
#include "ash/system/input_device_settings/input_device_settings_metadata.h"
#include "ash/system/input_device_settings/input_device_settings_pref_names.h"
#include "ash/system/input_device_settings/input_device_settings_utils.h"
#include "ash/system/input_device_settings/input_device_tracker.h"
#include "ash/system/input_device_settings/settings_updated_metrics_info.h"
#include "base/check.h"
#include "base/json/values_util.h"
#include "base/strings/strcat.h"
#include "base/time/time.h"
#include "base/values.h"
#include "components/account_id/account_id.h"
#include "components/prefs/pref_service.h"
#include "components/user_manager/known_user.h"
namespace ash {
namespace {
// Whether or not settings taken during the transition period should be
// persisted to the prefs. Values should only ever be true if the original
// setting was a user-configured value.
struct ForceMouseSettingPersistence {
bool swap_right = false;
bool sensitivity = false;
bool reverse_scrolling = false;
bool acceleration_enabled = false;
bool scroll_acceleration = false;
bool scroll_sensitivity = false;
};
bool GetDefaultSwapRightValue(const mojom::MousePolicies& mouse_policies) {
if (mouse_policies.swap_right_policy &&
mouse_policies.swap_right_policy->policy_status ==
mojom::PolicyStatus::kRecommended) {
return mouse_policies.swap_right_policy->value;
}
return kDefaultSwapRight;
}
// Append all missing button remappings to the current list with default
// remapping action.
void UpdateButtonRemappingsWithCompleteList(
mojom::MouseButtonConfig mouse_button_config,
std::vector<mojom::ButtonRemappingPtr>& current_button_remappings) {
auto default_remappings =
GetButtonRemappingListForConfig(mouse_button_config);
for (auto& remapping : default_remappings) {
const auto iter = std::ranges::find(
current_button_remappings, *remapping->button,
[](const mojom::ButtonRemappingPtr& current_remapping) {
return *current_remapping->button;
});
if (iter == current_button_remappings.end()) {
current_button_remappings.push_back(std::move(remapping));
}
}
}
// GetMouseSettingsFromPrefs returns a mouse settings based on user prefs
// to be used as settings for new mouses.
mojom::MouseSettingsPtr GetMouseSettingsFromPrefs(
PrefService* prefs,
const mojom::MousePolicies& mouse_policies,
ForceMouseSettingPersistence& force_persistence) {
mojom::MouseSettingsPtr settings = mojom::MouseSettings::New();
const auto* swap_right_preference =
prefs->GetUserPrefValue(prefs::kPrimaryMouseButtonRight);
settings->swap_right = swap_right_preference
? swap_right_preference->GetBool()
: GetDefaultSwapRightValue(mouse_policies);
force_persistence.swap_right = swap_right_preference != nullptr;
const auto* sensitivity_preference =
prefs->GetUserPrefValue(prefs::kMouseSensitivity);
settings->sensitivity = sensitivity_preference
? sensitivity_preference->GetInt()
: kDefaultSensitivity;
force_persistence.sensitivity = sensitivity_preference != nullptr;
const auto* reverse_scrolling_preference =
prefs->GetUserPrefValue(prefs::kMouseReverseScroll);
settings->reverse_scrolling = reverse_scrolling_preference
? reverse_scrolling_preference->GetBool()
: kDefaultReverseScrolling;
force_persistence.reverse_scrolling = reverse_scrolling_preference != nullptr;
const auto* acceleration_enabled_preference =
prefs->GetUserPrefValue(prefs::kMouseAcceleration);
settings->acceleration_enabled =
acceleration_enabled_preference
? acceleration_enabled_preference->GetBool()
: kDefaultAccelerationEnabled;
force_persistence.acceleration_enabled =
acceleration_enabled_preference != nullptr;
const auto* scroll_acceleration_preference =
prefs->GetUserPrefValue(prefs::kMouseScrollAcceleration);
settings->scroll_acceleration =
scroll_acceleration_preference ? scroll_acceleration_preference->GetBool()
: kDefaultScrollAccelerationEnabled;
force_persistence.scroll_acceleration =
scroll_acceleration_preference != nullptr;
const auto* scroll_sensitivity_preference =
prefs->GetUserPrefValue(prefs::kMouseScrollSensitivity);
settings->scroll_sensitivity = scroll_sensitivity_preference
? scroll_sensitivity_preference->GetInt()
: kDefaultScrollSensitivity;
force_persistence.scroll_sensitivity =
scroll_sensitivity_preference != nullptr;
return settings;
}
mojom::MouseSettingsPtr RetrieveMouseSettings(
const mojom::MousePolicies& mouse_policies,
const base::Value::Dict& settings_dict) {
mojom::MouseSettingsPtr settings = mojom::MouseSettings::New();
settings->swap_right =
settings_dict.FindBool(prefs::kMouseSettingSwapRight)
.value_or(GetDefaultSwapRightValue(mouse_policies));
settings->sensitivity = settings_dict.FindInt(prefs::kMouseSettingSensitivity)
.value_or(kDefaultSensitivity);
settings->reverse_scrolling =
settings_dict.FindBool(prefs::kMouseSettingReverseScrolling)
.value_or(kDefaultReverseScrolling);
settings->acceleration_enabled =
settings_dict.FindBool(prefs::kMouseSettingAccelerationEnabled)
.value_or(kDefaultAccelerationEnabled);
settings->scroll_sensitivity =
settings_dict.FindInt(prefs::kMouseSettingScrollSensitivity)
.value_or(kDefaultScrollSensitivity);
settings->scroll_acceleration =
settings_dict.FindBool(prefs::kMouseSettingScrollAcceleration)
.value_or(kDefaultScrollAccelerationEnabled);
return settings;
}
mojom::MouseSettingsPtr GetDefaultMouseSettings(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies) {
if (pref_service) {
return RetrieveMouseSettings(
mouse_policies, pref_service->GetDict(prefs::kMouseDefaultSettings));
}
return RetrieveMouseSettings(mouse_policies, /*settings_dict=*/{});
}
base::Value::Dict ConvertSettingsToDict(
const mojom::Mouse& mouse,
const mojom::MousePolicies& mouse_policies,
const ForceMouseSettingPersistence& force_persistence,
const base::Value::Dict* existing_settings_dict) {
// Populate `settings_dict` with all settings in `settings`.
base::Value::Dict settings_dict;
if (ShouldPersistSetting(
mouse_policies.swap_right_policy, prefs::kMouseSettingSwapRight,
mouse.settings->swap_right, GetDefaultSwapRightValue(mouse_policies),
force_persistence.swap_right, existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingSwapRight,
mouse.settings->swap_right);
}
if (ShouldPersistSetting(prefs::kMouseSettingSensitivity,
static_cast<int>(mouse.settings->sensitivity),
kDefaultSensitivity, force_persistence.sensitivity,
existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingSensitivity,
mouse.settings->sensitivity);
}
if (ShouldPersistSetting(
prefs::kMouseSettingReverseScrolling,
mouse.settings->reverse_scrolling, kDefaultReverseScrolling,
force_persistence.reverse_scrolling, existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingReverseScrolling,
mouse.settings->reverse_scrolling);
}
if (ShouldPersistSetting(
prefs::kMouseSettingAccelerationEnabled,
mouse.settings->acceleration_enabled, kDefaultAccelerationEnabled,
force_persistence.acceleration_enabled, existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingAccelerationEnabled,
mouse.settings->acceleration_enabled);
}
if (ShouldPersistSetting(prefs::kMouseSettingScrollSensitivity,
static_cast<int>(mouse.settings->scroll_sensitivity),
kDefaultScrollSensitivity,
force_persistence.scroll_sensitivity,
existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingScrollSensitivity,
mouse.settings->scroll_sensitivity);
}
if (ShouldPersistSetting(prefs::kMouseSettingScrollAcceleration,
mouse.settings->scroll_acceleration,
kDefaultScrollAccelerationEnabled,
force_persistence.scroll_acceleration,
existing_settings_dict)) {
settings_dict.Set(prefs::kMouseSettingScrollAcceleration,
mouse.settings->scroll_acceleration);
}
return settings_dict;
}
void UpdateButtonRemappingDictPref(PrefService* pref_service,
const mojom::Mouse& mouse,
const base::Time time_stamp) {
const mojom::MouseSettings& settings = *mouse.settings;
base::Value::List button_remappings = ConvertButtonRemappingArrayToList(
settings.button_remappings, mouse.customization_restriction);
base::Value::Dict button_remappings_dict =
pref_service->GetDict(prefs::kMouseButtonRemappingsDictPref).Clone();
button_remappings_dict.Set(mouse.device_key, std::move(button_remappings));
const auto time_stamp_path =
base::StrCat({prefs::kLastUpdatedKey, ".", mouse.device_key});
button_remappings_dict.SetByDottedPath(time_stamp_path,
base::TimeToValue(time_stamp));
pref_service->SetDict(std::string(prefs::kMouseButtonRemappingsDictPref),
std::move(button_remappings_dict));
}
void UpdateMouseSettingsImpl(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
const mojom::Mouse& mouse,
const ForceMouseSettingPersistence& force_persistence) {
DCHECK(mouse.settings);
const base::Time time_stamp = base::Time::Now();
base::Value::Dict devices_dict =
pref_service->GetDict(prefs::kMouseDeviceSettingsDictPref).Clone();
base::Value::Dict* existing_settings_dict =
devices_dict.FindDict(mouse.device_key);
base::Value::Dict settings_dict = ConvertSettingsToDict(
mouse, mouse_policies, force_persistence, existing_settings_dict);
settings_dict.Set(prefs::kLastUpdatedKey, base::TimeToValue(time_stamp));
// If an old settings dict already exists for the device, merge the updated
// settings into the old settings. Otherwise, insert the dict at
// `mouse.device_key`.
if (existing_settings_dict) {
existing_settings_dict->Merge(std::move(settings_dict));
} else {
devices_dict.Set(mouse.device_key, std::move(settings_dict));
}
pref_service->SetDict(std::string(prefs::kMouseDeviceSettingsDictPref),
std::move(devices_dict));
if (features::IsPeripheralCustomizationEnabled()) {
UpdateButtonRemappingDictPref(pref_service, mouse, time_stamp);
}
}
mojom::MouseSettingsPtr GetMouseSettingsFromOldLocalStatePrefs(
PrefService* local_state,
const AccountId& account_id,
const mojom::MousePolicies& mouse_policies,
const mojom::Mouse& mouse) {
mojom::MouseSettingsPtr settings =
GetDefaultMouseSettings(/*pref_service=*/nullptr, mouse_policies);
settings->swap_right =
user_manager::KnownUser(local_state)
.FindBoolPath(account_id, prefs::kOwnerPrimaryMouseButtonRight)
.value_or(kDefaultSwapRight);
return settings;
}
bool HasDefaultSettings(PrefService* pref_service) {
const auto* pref = pref_service->FindPreference(prefs::kMouseDefaultSettings);
return pref && pref->HasUserSetting();
}
void InitializeSettingsUpdateMetricInfo(
PrefService* pref_service,
const mojom::Mouse& mouse,
SettingsUpdatedMetricsInfo::Category category) {
CHECK(pref_service);
const auto& settings_metric_info =
pref_service->GetDict(prefs::kMouseUpdateSettingsMetricInfo);
const auto* device_metric_info = settings_metric_info.Find(mouse.device_key);
if (device_metric_info) {
return;
}
auto updated_metric_info = settings_metric_info.Clone();
const SettingsUpdatedMetricsInfo metrics_info(category, base::Time::Now());
updated_metric_info.Set(mouse.device_key, metrics_info.ToDict());
pref_service->SetDict(prefs::kMouseUpdateSettingsMetricInfo,
std::move(updated_metric_info));
}
void InitializeMouseSettingsImpl(PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
mojom::Mouse* mouse,
bool force_initialize_to_default_settings) {
if (!pref_service) {
mouse->settings = GetDefaultMouseSettings(pref_service, mouse_policies);
return;
}
const auto& devices_dict =
pref_service->GetDict(prefs::kMouseDeviceSettingsDictPref);
const auto* settings_dict = devices_dict.FindDict(mouse->device_key);
if (force_initialize_to_default_settings) {
settings_dict = nullptr;
}
ForceMouseSettingPersistence force_persistence;
SettingsUpdatedMetricsInfo::Category category;
if (settings_dict) {
category = SettingsUpdatedMetricsInfo::Category::kSynced;
mouse->settings = RetrieveMouseSettings(mouse_policies, *settings_dict);
} else if (Shell::Get()->input_device_tracker()->WasDevicePreviouslyConnected(
InputDeviceTracker::InputDeviceCategory::kMouse,
mouse->device_key)) {
category = SettingsUpdatedMetricsInfo::Category::kDefault;
mouse->settings = GetMouseSettingsFromPrefs(pref_service, mouse_policies,
force_persistence);
} else {
mouse->settings = GetDefaultMouseSettings(pref_service, mouse_policies);
category = HasDefaultSettings(pref_service)
? SettingsUpdatedMetricsInfo::Category::kDefault
: SettingsUpdatedMetricsInfo::Category::kFirstEver;
}
if (category == SettingsUpdatedMetricsInfo::Category::kSynced) {
PR_LOG(INFO, Feature::IDS)
<< GetMouseSettingsLog("Synced with latest settings", *mouse);
} else if (category == SettingsUpdatedMetricsInfo::Category::kDefault) {
PR_LOG(INFO, Feature::IDS)
<< GetMouseSettingsLog("Using default settings", *mouse);
} else {
PR_LOG(INFO, Feature::IDS)
<< GetMouseSettingsLog("First time connected", *mouse);
}
if (features::IsPeripheralCustomizationEnabled()) {
const auto& button_remappings_dict =
pref_service->GetDict(prefs::kMouseButtonRemappingsDictPref);
const auto* button_remappings_list =
button_remappings_dict.FindList(mouse->device_key);
if (button_remappings_list) {
auto button_remappings = ConvertListToButtonRemappingArray(
*button_remappings_list, mouse->customization_restriction);
UpdateButtonRemappingsWithCompleteList(mouse->mouse_button_config,
button_remappings);
mouse->settings->button_remappings = std::move(button_remappings);
} else {
mouse->settings->button_remappings =
GetButtonRemappingListForConfig(mouse->mouse_button_config);
}
}
DCHECK(mouse->settings);
InitializeSettingsUpdateMetricInfo(pref_service, *mouse, category);
UpdateMouseSettingsImpl(pref_service, mouse_policies, *mouse,
force_persistence);
if (mouse_policies.swap_right_policy &&
mouse_policies.swap_right_policy->policy_status ==
mojom::PolicyStatus::kManaged) {
mouse->settings->swap_right = mouse_policies.swap_right_policy->value;
}
}
} // namespace
MousePrefHandlerImpl::MousePrefHandlerImpl() = default;
MousePrefHandlerImpl::~MousePrefHandlerImpl() = default;
void MousePrefHandlerImpl::InitializeMouseSettings(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
mojom::Mouse* mouse) {
InitializeMouseSettingsImpl(pref_service, mouse_policies, mouse,
/*force_initialize_to_default_settings=*/false);
}
void MousePrefHandlerImpl::UpdateMouseSettings(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
const mojom::Mouse& mouse) {
UpdateMouseSettingsImpl(pref_service, mouse_policies, mouse,
/*force_persistence=*/{});
}
void MousePrefHandlerImpl::InitializeLoginScreenMouseSettings(
PrefService* local_state,
const AccountId& account_id,
const mojom::MousePolicies& mouse_policies,
mojom::Mouse* mouse) {
// Verify if the flag is enabled.
if (!features::IsInputDeviceSettingsSplitEnabled()) {
return;
}
CHECK(local_state);
const auto* settings_dict = GetLoginScreenSettingsDict(
local_state, account_id,
mouse->is_external ? prefs::kMouseLoginScreenExternalSettingsPref
: prefs::kMouseLoginScreenInternalSettingsPref);
if (settings_dict) {
mouse->settings = RetrieveMouseSettings(mouse_policies, *settings_dict);
} else {
mouse->settings = GetMouseSettingsFromOldLocalStatePrefs(
local_state, account_id, mouse_policies, *mouse);
}
if (mouse_policies.swap_right_policy &&
mouse_policies.swap_right_policy->policy_status ==
mojom::PolicyStatus::kManaged) {
mouse->settings->swap_right = mouse_policies.swap_right_policy->value;
}
if (features::IsPeripheralCustomizationEnabled()) {
const auto* button_remappings_list = GetLoginScreenButtonRemappingList(
local_state, account_id,
prefs::kMouseLoginScreenButtonRemappingListPref);
if (button_remappings_list) {
mouse->settings->button_remappings = ConvertListToButtonRemappingArray(
*button_remappings_list, mouse->customization_restriction);
} else {
mouse->settings->button_remappings =
GetButtonRemappingListForConfig(mouse->mouse_button_config);
}
}
}
void MousePrefHandlerImpl::UpdateLoginScreenMouseSettings(
PrefService* local_state,
const AccountId& account_id,
const mojom::MousePolicies& mouse_policies,
const mojom::Mouse& mouse) {
CHECK(local_state);
const auto* pref_name = mouse.is_external
? prefs::kMouseLoginScreenExternalSettingsPref
: prefs::kMouseLoginScreenInternalSettingsPref;
auto* settings_dict =
GetLoginScreenSettingsDict(local_state, account_id, pref_name);
user_manager::KnownUser(local_state)
.SetPath(
account_id, pref_name,
std::make_optional<base::Value>(ConvertSettingsToDict(
mouse, mouse_policies, /*force_persistence=*/{}, settings_dict)));
if (features::IsPeripheralCustomizationEnabled()) {
const auto* button_remapping_list_pref =
prefs::kMouseLoginScreenButtonRemappingListPref;
user_manager::KnownUser(local_state)
.SetPath(
account_id, button_remapping_list_pref,
std::make_optional<base::Value>(ConvertButtonRemappingArrayToList(
mouse.settings->button_remappings,
mouse.customization_restriction,
/*redact_button_names=*/true)));
}
}
void MousePrefHandlerImpl::InitializeWithDefaultMouseSettings(
const mojom::MousePolicies& mouse_policies,
mojom::Mouse* mouse) {
mouse->settings =
GetDefaultMouseSettings(/*pref_service=*/nullptr, mouse_policies);
}
void MousePrefHandlerImpl::UpdateDefaultMouseSettings(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
const mojom::Mouse& mouse) {
// All settings should be persisted fully when storing defaults.
auto settings_dict =
ConvertSettingsToDict(mouse, mouse_policies, /*force_persistence=*/{true},
/*existing_settings_dict=*/nullptr);
pref_service->SetDict(prefs::kMouseDefaultSettings, std::move(settings_dict));
}
void MousePrefHandlerImpl::ForceInitializeWithDefaultSettings(
PrefService* pref_service,
const mojom::MousePolicies& mouse_policies,
mojom::Mouse* mouse) {
InitializeMouseSettingsImpl(pref_service, mouse_policies, mouse,
/*force_initialize_to_default_settings=*/true);
}
} // namespace ash
|