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 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
|
// Copyright 2013 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/ui/webui/accessibility/accessibility_ui.h"
#include <algorithm>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "base/command_line.h"
#include "base/containers/fixed_flat_map.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/json/json_writer.h"
#include "base/memory/raw_ref.h"
#include "base/notreached.h"
#include "base/strings/escape.h"
#include "base/strings/pattern.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/trace_event/trace_event.h"
#include "base/tracing/protos/chrome_track_event.pbzero.h"
#include "build/build_config.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/common/pref_names.h"
#include "chrome/common/webui_url_constants.h"
#include "chrome/grit/accessibility_resources.h"
#include "chrome/grit/accessibility_resources_map.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/ax_inspect_factory.h"
#include "content/public/browser/browser_accessibility_state.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/favicon_status.h"
#include "content/public/browser/navigation_entry.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_iterator.h"
#include "content/public/browser/scoped_accessibility_mode.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_delegate.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "content/public/browser/web_ui_data_source.h"
#include "ui/accessibility/accessibility_features.h"
#include "ui/accessibility/ax_updates_and_events.h"
#include "ui/accessibility/platform/ax_platform.h"
#include "ui/accessibility/platform/ax_platform_node.h"
#include "ui/accessibility/platform/ax_platform_node_delegate.h"
#include "ui/accessibility/platform/inspect/ax_tree_formatter.h"
#include "ui/base/webui/web_ui_util.h"
#include "ui/views/accessibility/view_accessibility.h"
#if !BUILDFLAG(IS_ANDROID)
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_window.h"
#include "ui/views/accessibility/widget_ax_tree_id_map.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_delegate.h"
#endif
static const char kTargetsDataFile[] = "targets-data.json";
static const char kAccessibilityModeField[] = "a11yMode";
static const char kBrowsersField[] = "browsers";
static const char kEnabledField[] = "enabled";
static const char kErrorField[] = "error";
static const char kEventLogsField[] = "eventLogs";
static const char kFaviconUrlField[] = "faviconUrl";
static const char kFlagNameField[] = "flagName";
static const char kStringNameField[] = "stringName";
static const char kModeIdField[] = "modeId";
static const char kNameField[] = "name";
static const char kPagesField[] = "pages";
static const char kPidField[] = "pid";
static const char kProcessIdField[] = "processId";
static const char kRequestTypeField[] = "requestType";
static const char kRoutingIdField[] = "routingId";
static const char kSessionIdField[] = "sessionId";
static const char kShouldRequestTreeField[] = "shouldRequestTree";
static const char kSupportedApiTypesField[] = "supportedApiTypes";
static const char kStartField[] = "start";
static const char kTreeField[] = "tree";
static const char kTypeField[] = "type";
static const char kUrlField[] = "url";
static const char kValueField[] = "value";
static const char kApiTypeField[] = "apiType";
#if defined(USE_AURA) && !BUILDFLAG(IS_CHROMEOS)
static const char kWidget[] = "widget";
#endif
// Global flags
static const char kBrowser[] = "browser";
static const char kCopyTree[] = "copyTree";
static const char kHTML[] = "html";
static const char kLockedPlatformModes[] = "lockedPlatformModes";
static const char kIsolate[] = "isolate";
static const char kLocked[] = "locked";
static const char kNative[] = "native";
static const char kPage[] = "page";
static const char kPDFPrinting[] = "pdfPrinting";
static const char kExtendedProperties[] = "extendedProperties";
static const char kScreenReader[] = "screenReader";
static const char kShowOrRefreshTree[] = "showOrRefreshTree";
static const char kText[] = "text";
static const char kWeb[] = "web";
// Screen reader detection.
static const char kDetectedATName[] = "detectedATName";
static const char kIsScreenReaderActive[] = "isScreenReaderActive";
using ui::AXPropertyFilter;
namespace {
base::Value::Dict BuildTargetDescriptor(
const GURL& url,
const std::string& name,
const GURL& favicon_url,
int process_id,
int routing_id,
ui::AXMode accessibility_mode,
base::ProcessHandle handle = base::kNullProcessHandle) {
base::Value::Dict target_data;
target_data.Set(kProcessIdField, process_id);
target_data.Set(kRoutingIdField, routing_id);
target_data.Set(kUrlField, url.spec());
target_data.Set(kNameField, base::EscapeForHTML(name));
target_data.Set(kPidField, static_cast<int>(base::GetProcId(handle)));
target_data.Set(kFaviconUrlField, favicon_url.spec());
target_data.Set(kAccessibilityModeField,
static_cast<int>(accessibility_mode.flags()));
target_data.Set(kTypeField, kPage);
return target_data;
}
base::Value::Dict BuildTargetDescriptor(content::RenderViewHost* rvh) {
TRACE_EVENT1("accessibility", "BuildTargetDescriptor", "render_view_host",
rvh);
content::WebContents* web_contents =
content::WebContents::FromRenderViewHost(rvh);
ui::AXMode accessibility_mode;
std::string title;
GURL url;
GURL favicon_url;
if (web_contents) {
// TODO(nasko): Fix the following code to use a consistent set of data
// across the URL, title, and favicon.
url = web_contents->GetURL();
title = base::UTF16ToUTF8(web_contents->GetTitle());
content::NavigationController& controller = web_contents->GetController();
content::NavigationEntry* entry = controller.GetVisibleEntry();
if (entry != nullptr && entry->GetURL().is_valid()) {
gfx::Image favicon_image = entry->GetFavicon().image;
if (!favicon_image.IsEmpty()) {
const SkBitmap* favicon_bitmap = favicon_image.ToSkBitmap();
favicon_url = GURL(webui::GetBitmapDataUrl(*favicon_bitmap));
}
}
accessibility_mode = web_contents->GetAccessibilityMode();
}
return BuildTargetDescriptor(url, title, favicon_url,
rvh->GetProcess()->GetDeprecatedID(),
rvh->GetRoutingID(), accessibility_mode);
}
#if !BUILDFLAG(IS_ANDROID)
base::Value::Dict BuildTargetDescriptor(Browser* browser) {
base::Value::Dict target_data;
target_data.Set(kSessionIdField, browser->session_id().id());
target_data.Set(kNameField, browser->GetWindowTitleForCurrentTab(false));
target_data.Set(kTypeField, kBrowser);
return target_data;
}
#endif // !BUILDFLAG(IS_ANDROID)
bool ShouldHandleAccessibilityRequestCallback(const std::string& path) {
return path == kTargetsDataFile;
}
void HandleAccessibilityRequestCallback(
content::BrowserContext* current_context,
ui::AXMode initial_process_mode,
const std::string& path,
content::WebUIDataSource::GotDataCallback callback) {
DCHECK(ShouldHandleAccessibilityRequestCallback(path));
auto& browser_accessibility_state =
*content::BrowserAccessibilityState::GetInstance();
base::Value::Dict data;
PrefService* pref = Profile::FromBrowserContext(current_context)->GetPrefs();
ui::AXMode mode = browser_accessibility_state.GetAccessibilityMode();
bool native = mode.has_mode(ui::AXMode::kNativeAPIs);
bool web = mode.has_mode(ui::AXMode::kWebContents);
bool text = mode.has_mode(ui::AXMode::kInlineTextBoxes);
bool extended_properties = mode.has_mode(ui::AXMode::kExtendedProperties);
bool screen_reader = mode.has_mode(ui::AXMode::kScreenReader);
bool html = mode.has_mode(ui::AXMode::kHTML);
bool pdf_printing = mode.has_mode(ui::AXMode::kPDFPrinting);
bool allow_platform_activation =
browser_accessibility_state.IsActivationFromPlatformEnabled();
ui::AssistiveTech assistive_tech =
ui::AXPlatform::GetInstance().active_assistive_tech();
bool is_screen_reader_active =
ui::AXPlatform::GetInstance().IsScreenReaderActive();
// The "native" and "web" flags are disabled if
// --disable-renderer-accessibility is set.
data.Set(kNative, native);
data.Set(kWeb, web);
// The "text", "extendedProperties" and "html" flags are only
// meaningful if "web" is enabled.
data.Set(kText, text);
data.Set(kExtendedProperties, extended_properties);
data.Set(kScreenReader, screen_reader);
data.Set(kHTML, html);
// The "pdfPrinting" flag is independent of the others.
data.Set(kPDFPrinting, pdf_printing);
// Identify the mode checkboxes that were turned on via platform API
// interactions and therefore cannot be unchecked unless the #isolate checkbox
// is checked.
data.Set(
kLockedPlatformModes,
base::Value::Dict()
.Set(kNative,
allow_platform_activation && native &&
initial_process_mode.has_mode(ui::AXMode::kNativeAPIs))
.Set(kWeb,
allow_platform_activation && web &&
initial_process_mode.has_mode(ui::AXMode::kWebContents))
.Set(kText,
allow_platform_activation && text &&
initial_process_mode.has_mode(ui::AXMode::kInlineTextBoxes))
.Set(kExtendedProperties, allow_platform_activation &&
extended_properties &&
initial_process_mode.has_mode(
ui::AXMode::kExtendedProperties))
.Set(kScreenReader,
allow_platform_activation && screen_reader &&
initial_process_mode.has_mode(ui::AXMode::kScreenReader))
.Set(kHTML, allow_platform_activation &&
initial_process_mode.has_mode(ui::AXMode::kHTML)));
data.Set(kDetectedATName, ui::GetAssistiveTechString(assistive_tech));
data.Set(kIsScreenReaderActive, is_screen_reader_active);
std::string pref_api_type =
pref->GetString(prefs::kShownAccessibilityApiType);
bool pref_api_type_supported = false;
std::vector<ui::AXApiType::Type> supported_api_types =
content::AXInspectFactory::SupportedApis();
base::Value::List supported_api_list;
supported_api_list.reserve(supported_api_types.size());
for (ui::AXApiType::Type type : supported_api_types) {
supported_api_list.Append(std::string_view(type));
if (type == ui::AXApiType::From(pref_api_type)) {
pref_api_type_supported = true;
}
}
data.Set(kSupportedApiTypesField, std::move(supported_api_list));
// If the saved API type is not supported, use the default platform formatter
// API type.
if (!pref_api_type_supported) {
pref_api_type = std::string_view(
content::AXInspectFactory::DefaultPlatformFormatterType());
}
data.Set(kApiTypeField, pref_api_type);
data.Set(kIsolate, !allow_platform_activation);
data.Set(kLocked, !browser_accessibility_state.IsAXModeChangeAllowed());
base::Value::List page_list;
std::unique_ptr<content::RenderWidgetHostIterator> widget_iter(
content::RenderWidgetHost::GetRenderWidgetHosts());
while (content::RenderWidgetHost* widget = widget_iter->GetNextHost()) {
// Ignore processes that don't have a connection, such as crashed tabs.
if (!widget->GetProcess()->IsInitializedAndNotDead()) {
continue;
}
content::RenderViewHost* rvh = content::RenderViewHost::From(widget);
if (!rvh) {
continue;
}
content::WebContents* web_contents =
content::WebContents::FromRenderViewHost(rvh);
content::WebContentsDelegate* delegate = web_contents->GetDelegate();
if (!delegate) {
continue;
}
if (web_contents->GetPrimaryMainFrame()->GetRenderViewHost() != rvh) {
continue;
}
// Ignore views that are never user-visible, like background pages.
if (web_contents->IsNeverComposited()) {
continue;
}
content::BrowserContext* context = rvh->GetProcess()->GetBrowserContext();
if (context != current_context) {
continue;
}
base::Value::Dict descriptor = BuildTargetDescriptor(rvh);
descriptor.Set(kNative, native);
descriptor.Set(kExtendedProperties, extended_properties);
descriptor.Set(kScreenReader, screen_reader);
descriptor.Set(kWeb, web);
page_list.Append(std::move(descriptor));
}
data.Set(kPagesField, std::move(page_list));
base::Value::List browser_list;
#if !BUILDFLAG(IS_ANDROID)
for (Browser* browser : *BrowserList::GetInstance()) {
browser_list.Append(BuildTargetDescriptor(browser));
}
#endif // !BUILDFLAG(IS_ANDROID)
data.Set(kBrowsersField, std::move(browser_list));
std::string json_string;
base::JSONWriter::Write(data, &json_string);
std::move(callback).Run(
base::MakeRefCounted<base::RefCountedString>(std::move(json_string)));
}
std::string RecursiveDumpAXPlatformNodeAsString(
ui::AXPlatformNode* node,
int indent,
const std::vector<AXPropertyFilter>& property_filters) {
if (!node) {
return "";
}
std::string str(2 * indent, '+');
ui::AXPlatformNodeDelegate* const node_delegate = node->GetDelegate();
std::string line = node_delegate->GetData().ToString();
std::vector<std::string> attributes = base::SplitString(
line, " ", base::KEEP_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
for (const std::string& attribute : attributes) {
if (ui::AXTreeFormatter::MatchesPropertyFilters(property_filters, attribute,
false)) {
str += attribute + " ";
}
}
str += "\n";
for (size_t i = 0, child_count = node_delegate->GetChildCount();
i < child_count; i++) {
gfx::NativeViewAccessible child = node_delegate->ChildAtIndex(i);
ui::AXPlatformNode* child_node =
ui::AXPlatformNode::FromNativeViewAccessible(child);
str += RecursiveDumpAXPlatformNodeAsString(child_node, indent + 1,
property_filters);
}
return str;
}
// Add property filters to the property_filters vector for the given property
// filter type. The attributes are passed in as a string with each attribute
// separated by a space.
void AddPropertyFilters(std::vector<AXPropertyFilter>& property_filters,
const std::string& attributes,
AXPropertyFilter::Type type) {
for (const std::string& attribute : base::SplitString(
attributes, " ", base::KEEP_WHITESPACE, base::SPLIT_WANT_NONEMPTY)) {
property_filters.emplace_back(attribute, type);
}
}
bool IsValidJSValue(const std::string* str) {
return str && str->length() < 5000U;
}
const std::string& CheckJSValue(const std::string* str) {
CHECK(IsValidJSValue(str));
return *str;
}
// A holder for process-wide and per-tab accessibility state. An instance of
// this class is attached to the WebContents hosting chrome://accessibility.
// This state is not attached to AccessibilityUIMessageHandler, as it does not
// survive page reload in some situations; see https://crbug.com/355190669. An
// instance of this class monitors its WebContents's primary page and
// saves/restores accessibility state as the user navigates away from and back
// to chrome://accessibility.
class AccessibilityUiModes
: public content::WebContentsUserData<AccessibilityUiModes>,
public content::WebContentsObserver {
public:
~AccessibilityUiModes() override = default;
// Returns the instance for the WebContents hosting chrome://accessibility.
static AccessibilityUiModes& GetInstance(content::WebContents* web_contents) {
CreateForWebContents(web_contents);
return *FromWebContents(web_contents);
}
// Sets flags for all tabs in the browser process for the lifetime of the
// accessibility UI page.
void SetModeForProcess(uint32_t flags, bool enabled) {
if (process_accessibility_mode_) {
ui::AXMode mode = process_accessibility_mode_->mode();
mode.set_mode(flags, enabled);
process_accessibility_mode_ =
content::BrowserAccessibilityState::GetInstance()
->CreateScopedModeForProcess(mode);
}
}
// Applies `mode` to `web_contents` for the lifetime of the accessibility
// UI page.
void SetModeForWebContents(content::WebContents* web_contents,
ui::AXMode mode) {
// Create/replace a ScopedAccessibilityMode targeting `web_contents`.
auto scoped_mode = content::BrowserAccessibilityState::GetInstance()
->CreateScopedModeForWebContents(web_contents, mode);
auto [iter, inserted] = page_accessibility_modes_.try_emplace(
web_contents, *this, *web_contents, std::move(scoped_mode));
if (!inserted) {
iter->second.SetMode(std::move(scoped_mode));
}
}
// content::WebContentsObserver:
void PrimaryPageChanged(content::Page& page) override {
const GURL& new_page_url = GetWebContents().GetLastCommittedURL();
if (new_page_url != page_url_) {
if (process_accessibility_mode_) {
// Navigating away from chrome://accessibility. Save the process mode.
SaveAccessibilityState();
}
} else if (!process_accessibility_mode_) {
// Navigating back to chrome://accessibility. Restore the process mode.
RestoreAccessibilityState();
}
}
private:
friend content::WebContentsUserData<AccessibilityUiModes>;
WEB_CONTENTS_USER_DATA_KEY_DECL();
explicit AccessibilityUiModes(content::WebContents* web_contents)
: WebContentsUserData(*web_contents),
WebContentsObserver(web_contents),
page_url_(web_contents->GetLastCommittedURL()),
process_accessibility_mode_(
content::BrowserAccessibilityState::GetInstance()
->CreateScopedModeForProcess(ui::AXMode())) {}
// Saves the process-wide and per-tab accessibility mode flags and clears
// all ScopedAccessibilityMode instances managed for this instance of the
// accessibility UI page.
void SaveAccessibilityState() {
saved_process_mode_ = process_accessibility_mode_->mode();
process_accessibility_mode_.reset();
std::ranges::for_each(
page_accessibility_modes_,
[](PageAccessibilityMode& page_mode) { page_mode.Save(); },
&std::map<void*, PageAccessibilityMode>::value_type::second);
}
// Restores the process-wide and per-tab accessibility mode flags and clears
// all ScopedAccessibilityMode instances managed for this instance of the
// accessibility UI page.
void RestoreAccessibilityState() {
auto& browser_accessibility_state =
*content::BrowserAccessibilityState::GetInstance();
process_accessibility_mode_ =
browser_accessibility_state.CreateScopedModeForProcess(
std::exchange(saved_process_mode_, ui::AXMode()));
std::ranges::for_each(
page_accessibility_modes_,
[&browser_accessibility_state](PageAccessibilityMode& page_mode) {
page_mode.Restore(browser_accessibility_state);
},
&std::map<void*, PageAccessibilityMode>::value_type::second);
}
void OnPageDestroyed(content::WebContents& page_web_contents) {
page_accessibility_modes_.erase(&page_web_contents);
}
// A ScopedAccessibilityMode for a page hosted in a WebContents.
class PageAccessibilityMode : public content::WebContentsObserver {
public:
PageAccessibilityMode(
AccessibilityUiModes& parent,
content::WebContents& web_contents,
std::unique_ptr<content::ScopedAccessibilityMode> accessibility_mode);
PageAccessibilityMode(const PageAccessibilityMode&) = delete;
PageAccessibilityMode& operator=(const PageAccessibilityMode&) = delete;
~PageAccessibilityMode() override;
void SetMode(
std::unique_ptr<content::ScopedAccessibilityMode> accessibility_mode);
void Save();
void Restore(
content::BrowserAccessibilityState& browser_accessibility_state);
// content::WebContentsObserver:
void WebContentsDestroyed() override;
private:
const raw_ref<AccessibilityUiModes> parent_;
std::unique_ptr<content::ScopedAccessibilityMode> accessibility_mode_;
// The accessibility mode for this WebContents when the accessibility UI
// page is no longer the primary page in its WebContents.
ui::AXMode saved_mode_;
};
// The URL of the chrome://accessibility page visible in the WebContents.
const GURL page_url_;
// Accessibility modes for pages in WebContentses. The map's key is a pointer
// to a WebContents.
std::map<void*, PageAccessibilityMode> page_accessibility_modes_;
// A ScopedAccessibilityMode that holds the process-wide ("global") mode flags
// modified via the `setGlobalFlag` callback from the page. Holds at least an
// instance with no mode flags set while the chrome://accessibility page is
// the primary page in its WebContents.
std::unique_ptr<content::ScopedAccessibilityMode> process_accessibility_mode_;
// The process-wide accessibility mode when the accessibility UI page is no
// longer the primary page in its WebContents.
ui::AXMode saved_process_mode_;
};
WEB_CONTENTS_USER_DATA_KEY_IMPL(AccessibilityUiModes);
AccessibilityUiModes::PageAccessibilityMode::PageAccessibilityMode(
AccessibilityUiModes& parent,
content::WebContents& web_contents,
std::unique_ptr<content::ScopedAccessibilityMode> accessibility_mode)
: content::WebContentsObserver(&web_contents),
parent_(parent),
accessibility_mode_(std::move(accessibility_mode)) {}
AccessibilityUiModes::PageAccessibilityMode::~PageAccessibilityMode() = default;
void AccessibilityUiModes::PageAccessibilityMode::SetMode(
std::unique_ptr<content::ScopedAccessibilityMode> accessibility_mode) {
accessibility_mode_ = std::move(accessibility_mode);
}
void AccessibilityUiModes::PageAccessibilityMode::Save() {
saved_mode_ = accessibility_mode_->mode();
accessibility_mode_.reset();
}
void AccessibilityUiModes::PageAccessibilityMode::Restore(
content::BrowserAccessibilityState& browser_accessibility_state) {
accessibility_mode_ =
browser_accessibility_state.CreateScopedModeForWebContents(
web_contents(), std::exchange(saved_mode_, ui::AXMode()));
}
void AccessibilityUiModes::PageAccessibilityMode::WebContentsDestroyed() {
parent_->OnPageDestroyed(*web_contents());
}
} // namespace
AccessibilityUIConfig::AccessibilityUIConfig()
: DefaultWebUIConfig(content::kChromeUIScheme,
chrome::kChromeUIAccessibilityHost) {}
AccessibilityUIConfig::~AccessibilityUIConfig() = default;
AccessibilityUI::AccessibilityUI(content::WebUI* web_ui)
: WebUIController(web_ui) {
auto* const browser_context = web_ui->GetWebContents()->GetBrowserContext();
// Set up the chrome://accessibility source.
content::WebUIDataSource* html_source =
content::WebUIDataSource::CreateAndAdd(
browser_context, chrome::kChromeUIAccessibilityHost);
// The process-wide accessibility mode when the UI page is initially launched.
ui::AXMode initial_process_mode =
content::BrowserAccessibilityState::GetInstance()->GetAccessibilityMode();
// Add required resources.
html_source->UseStringsJs();
html_source->AddResourcePaths(kAccessibilityResources);
html_source->SetDefaultResource(IDR_ACCESSIBILITY_ACCESSIBILITY_HTML);
html_source->SetRequestFilter(
base::BindRepeating(&ShouldHandleAccessibilityRequestCallback),
base::BindRepeating(&HandleAccessibilityRequestCallback, browser_context,
initial_process_mode));
html_source->OverrideContentSecurityPolicy(
network::mojom::CSPDirectiveName::TrustedTypes,
"trusted-types parse-html-subset sanitize-inner-html;");
web_ui->AddMessageHandler(std::make_unique<AccessibilityUIMessageHandler>());
}
AccessibilityUI::~AccessibilityUI() = default;
AccessibilityUIObserver::AccessibilityUIObserver(
content::WebContents* web_contents,
std::vector<std::string>* event_logs)
: content::WebContentsObserver(web_contents), event_logs_(event_logs) {}
AccessibilityUIObserver::~AccessibilityUIObserver() = default;
void AccessibilityUIObserver::AccessibilityEventReceived(
const ui::AXUpdatesAndEvents& details) {
for (const ui::AXEvent& event : details.events) {
event_logs_->push_back(event.ToString());
}
}
AccessibilityUIMessageHandler::AccessibilityUIMessageHandler() = default;
AccessibilityUIMessageHandler::~AccessibilityUIMessageHandler() {
if (!observer_) {
return;
}
content::WebContents* web_contents = observer_->web_contents();
if (!web_contents) {
return;
}
StopRecording(web_contents);
}
void AccessibilityUIMessageHandler::RegisterMessages() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
web_ui()->RegisterMessageCallback(
"toggleAccessibility",
base::BindRepeating(
&AccessibilityUIMessageHandler::ToggleAccessibilityForWebContents,
base::Unretained(this)));
web_ui()->RegisterMessageCallback(
"setGlobalFlag",
base::BindRepeating(&AccessibilityUIMessageHandler::SetGlobalFlag,
base::Unretained(this)));
web_ui()->RegisterMessageCallback(
"setGlobalString",
base::BindRepeating(&AccessibilityUIMessageHandler::SetGlobalString,
base::Unretained(this)));
web_ui()->RegisterMessageCallback(
"requestWebContentsTree",
base::BindRepeating(
&AccessibilityUIMessageHandler::RequestWebContentsTree,
base::Unretained(this)));
web_ui()->RegisterMessageCallback(
"requestNativeUITree",
base::BindRepeating(&AccessibilityUIMessageHandler::RequestNativeUITree,
base::Unretained(this)));
#if defined(USE_AURA) && !BUILDFLAG(IS_CHROMEOS)
web_ui()->RegisterMessageCallback(
"requestWidgetsTree",
base::BindRepeating(&AccessibilityUIMessageHandler::RequestWidgetsTree,
base::Unretained(this)));
#endif
web_ui()->RegisterMessageCallback(
"requestAccessibilityEvents",
base::BindRepeating(
&AccessibilityUIMessageHandler::RequestAccessibilityEvents,
base::Unretained(this)));
}
void AccessibilityUIMessageHandler::ToggleAccessibilityForWebContents(
const base::Value::List& args) {
const base::Value::Dict& data = args[0].GetDict();
int process_id = *data.FindInt(kProcessIdField);
int routing_id = *data.FindInt(kRoutingIdField);
int mode = *data.FindInt(kModeIdField);
bool should_request_tree = *data.FindBool(kShouldRequestTreeField);
AllowJavascript();
content::RenderViewHost* rvh =
content::RenderViewHost::FromID(process_id, routing_id);
if (!rvh) {
return;
}
content::WebContents* web_contents =
content::WebContents::FromRenderViewHost(rvh);
ui::AXMode current_mode = web_contents->GetAccessibilityMode();
if (mode & ui::AXMode::kNativeAPIs) {
current_mode.set_mode(ui::AXMode::kNativeAPIs, true);
}
if (mode & ui::AXMode::kWebContents) {
current_mode.set_mode(ui::AXMode::kWebContents, true);
}
if (mode & ui::AXMode::kInlineTextBoxes) {
current_mode.set_mode(ui::AXMode::kInlineTextBoxes, true);
}
if (mode & ui::AXMode::kExtendedProperties) {
current_mode.set_mode(ui::AXMode::kExtendedProperties, true);
}
if (mode & ui::AXMode::kHTML) {
current_mode.set_mode(ui::AXMode::kHTML, true);
}
AccessibilityUiModes::GetInstance(web_ui()->GetWebContents())
.SetModeForWebContents(web_contents, current_mode);
if (should_request_tree) {
base::Value::Dict request_data;
request_data.Set(kProcessIdField, process_id);
request_data.Set(kRoutingIdField, routing_id);
request_data.Set(kRequestTypeField, kShowOrRefreshTree);
base::Value::List request_args;
request_args.Append(std::move(request_data));
RequestWebContentsTree(request_args);
} else {
// Call accessibility.showOrRefreshTree without a 'tree' field so the row's
// accessibility mode buttons are updated.
AllowJavascript();
base::Value::Dict new_mode = BuildTargetDescriptor(rvh);
FireWebUIListener("showOrRefreshTree", new_mode);
}
}
void AccessibilityUIMessageHandler::SetGlobalFlag(
const base::Value::List& args) {
auto& browser_accessibility_state =
*content::BrowserAccessibilityState::GetInstance();
const base::Value::Dict& data = args[0].GetDict();
const std::string flag_name = CheckJSValue(data.FindString(kFlagNameField));
bool enabled = *data.FindBool(kEnabledField);
AllowJavascript();
if (flag_name == kIsolate) {
browser_accessibility_state.SetActivationFromPlatformEnabled(!enabled);
return;
}
if (flag_name == kLocked) {
browser_accessibility_state.SetAXModeChangeAllowed(!enabled);
return;
}
ui::AXMode new_mode;
if (flag_name == kNative) {
new_mode = ui::AXMode::kNativeAPIs;
} else if (flag_name == kWeb) {
new_mode = ui::AXMode::kWebContents;
} else if (flag_name == kText) {
new_mode = ui::AXMode::kInlineTextBoxes;
} else if (flag_name == kExtendedProperties) {
new_mode = ui::AXMode::kExtendedProperties;
} else if (flag_name == kScreenReader) {
new_mode = ui::AXMode::kScreenReader;
} else if (flag_name == kHTML) {
new_mode = ui::AXMode::kHTML;
} else {
NOTREACHED();
}
// It doesn't make sense to enable one of the flags that depends on
// web contents without enabling web contents accessibility too.
if (enabled && (new_mode.has_mode(ui::AXMode::kInlineTextBoxes) ||
new_mode.has_mode(ui::AXMode::kExtendedProperties) ||
new_mode.has_mode(ui::AXMode::kHTML))) {
new_mode.set_mode(ui::AXMode::kWebContents, true);
}
// Similarly if you disable web accessibility we should remove all
// flags that depend on it.
if (!enabled && new_mode.has_mode(ui::AXMode::kWebContents)) {
new_mode.set_mode(ui::AXMode::kInlineTextBoxes, true);
new_mode.set_mode(ui::AXMode::kExtendedProperties, true);
new_mode.set_mode(ui::AXMode::kHTML, true);
}
AccessibilityUiModes::GetInstance(web_ui()->GetWebContents())
.SetModeForProcess(new_mode.flags(), enabled);
}
void AccessibilityUIMessageHandler::SetGlobalString(
const base::Value::List& args) {
const base::Value::Dict& data = args[0].GetDict();
const std::string string_name =
CheckJSValue(data.FindString(kStringNameField));
const std::string value = CheckJSValue(data.FindString(kValueField));
if (string_name == kApiTypeField) {
PrefService* pref = Profile::FromWebUI(web_ui())->GetPrefs();
pref->SetString(prefs::kShownAccessibilityApiType, value);
}
}
void AccessibilityUIMessageHandler::GetRequestTypeAndFilters(
const base::Value::Dict& data,
std::string& request_type,
std::string& allow,
std::string& allow_empty,
std::string& deny) {
request_type = CheckJSValue(data.FindString(kRequestTypeField));
CHECK(request_type == kShowOrRefreshTree || request_type == kCopyTree);
allow = CheckJSValue(data.FindStringByDottedPath("filters.allow"));
allow_empty = CheckJSValue(data.FindStringByDottedPath("filters.allowEmpty"));
deny = CheckJSValue(data.FindStringByDottedPath("filters.deny"));
}
void AccessibilityUIMessageHandler::RequestWebContentsTree(
const base::Value::List& args) {
const base::Value::Dict& data = args[0].GetDict();
std::string request_type, allow, allow_empty, deny;
GetRequestTypeAndFilters(data, request_type, allow, allow_empty, deny);
int process_id = *data.FindInt(kProcessIdField);
int routing_id = *data.FindInt(kRoutingIdField);
AllowJavascript();
content::RenderViewHost* rvh =
content::RenderViewHost::FromID(process_id, routing_id);
if (!rvh) {
base::Value::Dict result;
result.Set(kProcessIdField, process_id);
result.Set(kRoutingIdField, routing_id);
result.Set(kErrorField, "Renderer no longer exists.");
FireWebUIListener(request_type, result);
return;
}
base::Value::Dict result(BuildTargetDescriptor(rvh));
content::WebContents* web_contents =
content::WebContents::FromRenderViewHost(rvh);
// No matter the state of the current web_contents, we want to force the mode
// because we are about to show the accessibility tree
AccessibilityUiModes::GetInstance(web_ui()->GetWebContents())
.SetModeForWebContents(web_contents, ui::kAXModeComplete);
std::vector<AXPropertyFilter> property_filters;
AddPropertyFilters(property_filters, allow, AXPropertyFilter::ALLOW);
AddPropertyFilters(property_filters, allow_empty,
AXPropertyFilter::ALLOW_EMPTY);
AddPropertyFilters(property_filters, deny, AXPropertyFilter::DENY);
PrefService* pref = Profile::FromWebUI(web_ui())->GetPrefs();
ui::AXApiType::Type api_type =
ui::AXApiType::From(pref->GetString(prefs::kShownAccessibilityApiType));
std::string accessibility_contents =
web_contents->DumpAccessibilityTree(api_type, property_filters);
result.Set(kTreeField, accessibility_contents);
FireWebUIListener(request_type, result);
}
void AccessibilityUIMessageHandler::RequestNativeUITree(
const base::Value::List& args) {
const base::Value::Dict& data = args[0].GetDict();
std::string request_type, allow, allow_empty, deny;
GetRequestTypeAndFilters(data, request_type, allow, allow_empty, deny);
int session_id = *data.FindInt(kSessionIdField);
AllowJavascript();
#if !BUILDFLAG(IS_ANDROID)
std::vector<AXPropertyFilter> property_filters;
AddPropertyFilters(property_filters, allow, AXPropertyFilter::ALLOW);
AddPropertyFilters(property_filters, allow_empty,
AXPropertyFilter::ALLOW_EMPTY);
AddPropertyFilters(property_filters, deny, AXPropertyFilter::DENY);
for (Browser* browser : *BrowserList::GetInstance()) {
if (browser->session_id().id() == session_id) {
base::Value::Dict result = BuildTargetDescriptor(browser);
gfx::NativeWindow native_window = browser->window()->GetNativeWindow();
ui::AXPlatformNode* node =
ui::AXPlatformNode::FromNativeWindow(native_window);
result.Set(kTreeField, RecursiveDumpAXPlatformNodeAsString(
node, 0, property_filters));
FireWebUIListener(request_type, result);
return;
}
}
#endif // !BUILDFLAG(IS_ANDROID)
// No browser with the specified |session_id| was found.
base::Value::Dict result;
result.Set(kSessionIdField, session_id);
result.Set(kTypeField, kBrowser);
result.Set(kErrorField, "Browser no longer exists.");
FireWebUIListener(request_type, result);
}
void AccessibilityUIMessageHandler::RequestWidgetsTree(
const base::Value::List& args) {
#if defined(USE_AURA) && !BUILDFLAG(IS_CHROMEOS)
const base::Value::Dict& data = args[0].GetDict();
std::string request_type, allow, allow_empty, deny;
GetRequestTypeAndFilters(data, request_type, allow, allow_empty, deny);
std::vector<AXPropertyFilter> property_filters;
AddPropertyFilters(property_filters, allow, AXPropertyFilter::ALLOW);
AddPropertyFilters(property_filters, allow_empty,
AXPropertyFilter::ALLOW_EMPTY);
AddPropertyFilters(property_filters, deny, AXPropertyFilter::DENY);
base::Value::Dict result;
result.Set(kTypeField, kWidget);
result.Set(kErrorField, "Window no longer exists.");
AllowJavascript();
FireWebUIListener(request_type, result);
#endif // defined(USE_AURA) && !BUILDFLAG(IS_CHROMEOS)
}
void AccessibilityUIMessageHandler::Callback(const std::string& str) {
event_logs_.push_back(str);
}
void AccessibilityUIMessageHandler::StopRecording(
content::WebContents* web_contents) {
web_contents->RecordAccessibilityEvents(
GetRecordingApiType(), /*start_recording=*/false, std::nullopt);
observer_.reset(nullptr);
}
ui::AXApiType::Type AccessibilityUIMessageHandler::GetRecordingApiType() {
PrefService* pref = Profile::FromWebUI(web_ui())->GetPrefs();
const std::vector<ui::AXApiType::Type> supported_types =
content::AXInspectFactory::SupportedApis();
ui::AXApiType::Type api_type =
ui::AXApiType::From(pref->GetString(prefs::kShownAccessibilityApiType));
// Check to see if it is in the supported types list.
if (std::find(supported_types.begin(), supported_types.end(), api_type) ==
supported_types.end()) {
api_type = content::AXInspectFactory::DefaultPlatformRecorderType();
}
// Special cases for recording.
if (api_type == ui::AXApiType::kWinUIA) {
// The UIA event recorder currently does not work outside of tests,
// so use the platform default if the tree view is set to UIA.
// TODO: Remove this once the UIA event recorder is fixed. See:
// https://crbug.com/325316128
api_type = content::AXInspectFactory::DefaultPlatformRecorderType();
}
if (api_type == ui::AXApiType::kBlink) {
// kBlink is not a supported recording type, so use the platform default if
// the tree view is set to kBlink.
api_type = content::AXInspectFactory::DefaultPlatformRecorderType();
}
return api_type;
}
void AccessibilityUIMessageHandler::RequestAccessibilityEvents(
const base::Value::List& args) {
const base::Value::Dict& data = args[0].GetDict();
int process_id = *data.FindInt(kProcessIdField);
int routing_id = *data.FindInt(kRoutingIdField);
bool start_recording = *data.FindBool(kStartField);
AllowJavascript();
content::RenderViewHost* rvh =
content::RenderViewHost::FromID(process_id, routing_id);
if (!rvh) {
return;
}
base::Value::Dict result = BuildTargetDescriptor(rvh);
content::WebContents* web_contents =
content::WebContents::FromRenderViewHost(rvh);
if (start_recording) {
if (observer_) {
return;
}
web_contents->RecordAccessibilityEvents(
GetRecordingApiType(), /*start_recording=*/true,
base::BindRepeating(&AccessibilityUIMessageHandler::Callback,
weak_ptr_factory_.GetWeakPtr()));
observer_ =
std::make_unique<AccessibilityUIObserver>(web_contents, &event_logs_);
} else {
StopRecording(web_contents);
std::string event_logs_str;
for (const std::string& log : event_logs_) {
event_logs_str += log;
event_logs_str += "\n";
}
result.Set(kEventLogsField, event_logs_str);
event_logs_.clear();
FireWebUIListener("startOrStopEvents", result);
}
}
// static
void AccessibilityUIMessageHandler::RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) {
const std::string_view default_api_type =
std::string_view(ui::AXApiType::Type(ui::AXApiType::kBlink));
registry->RegisterStringPref(prefs::kShownAccessibilityApiType,
std::string(default_api_type));
}
|